Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+gogol@gmail.com> Toni Cebrián <toni@tonicebrian.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Vault.Matters.Holds.Update

Contents

Resource
- Constructing a Request

Description

Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.

See: Google Vault API Reference for vault.matters.holds.update.

Synopsis

type VaultMattersHoldsUpdateResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (Capture "holdId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Hold :> Put '[JSON] Hold)))))))))))
data VaultMattersHoldsUpdate = VaultMattersHoldsUpdate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- holdId :: Text
- matterId :: Text
- payload :: Hold
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVaultMattersHoldsUpdate :: Text -> Text -> Hold -> VaultMattersHoldsUpdate

Resource

type VaultMattersHoldsUpdateResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (Capture "holdId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Hold :> Put '[JSON] Hold))))))))))) Source #

A resource alias for vault.matters.holds.update method which the VaultMattersHoldsUpdate request conforms to.

Constructing a Request

data VaultMattersHoldsUpdate Source #

Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.

See: newVaultMattersHoldsUpdate smart constructor.

Constructors

VaultMattersHoldsUpdate
Fields xgafv :: Maybe Xgafv V1 error format. accessToken :: Maybe Text OAuth access token. callback :: Maybe Text JSONP holdId :: Text The ID of the hold. matterId :: Text The matter ID. payload :: Hold Multipart request metadata. uploadType :: Maybe Text Legacy upload protocol for media (e.g. "media", "multipart"). uploadProtocol :: Maybe Text Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

Associated Types

type Rep VaultMattersHoldsUpdate

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

Methods

from :: VaultMattersHoldsUpdate -> Rep VaultMattersHoldsUpdate x #

to :: Rep VaultMattersHoldsUpdate x -> VaultMattersHoldsUpdate #

Show VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

Methods

showsPrec :: Int -> VaultMattersHoldsUpdate -> ShowS #

show :: VaultMattersHoldsUpdate -> String #

showList :: [VaultMattersHoldsUpdate] -> ShowS #

Eq VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

Methods

(==) :: VaultMattersHoldsUpdate -> VaultMattersHoldsUpdate -> Bool #

(/=) :: VaultMattersHoldsUpdate -> VaultMattersHoldsUpdate -> Bool #

GoogleRequest VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

Associated Types

type Rs VaultMattersHoldsUpdate
Instance details Defined in Gogol.Vault.Matters.Holds.Update type Rs VaultMattersHoldsUpdate = Hold
type Scopes VaultMattersHoldsUpdate
Instance details Defined in Gogol.Vault.Matters.Holds.Update type Scopes VaultMattersHoldsUpdate = '[Ediscovery'FullControl]

Methods

requestClient :: VaultMattersHoldsUpdate -> GClient (Rs VaultMattersHoldsUpdate) #

type Rep VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

type Rs VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

type Rs VaultMattersHoldsUpdate = Hold

type Scopes VaultMattersHoldsUpdate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Update

type Scopes VaultMattersHoldsUpdate = '[Ediscovery'FullControl]

newVaultMattersHoldsUpdate Source #

Arguments

:: Text	The ID of the hold. See `holdId`.
-> Text	The matter ID. See `matterId`.
-> Hold	Multipart request metadata. See `payload`.
-> VaultMattersHoldsUpdate

Creates a value of VaultMattersHoldsUpdate with the minimum fields required to make a request.