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.Get

Contents

Resource
- Constructing a Request

Description

Gets the specified hold.

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

Synopsis

type VaultMattersHoldsGetResource = "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 "view" MattersHoldsGetView :> (QueryParam "alt" AltJSON :> Get '[JSON] Hold)))))))))))
data VaultMattersHoldsGet = VaultMattersHoldsGet {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- holdId :: Text
- matterId :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
- view :: Maybe MattersHoldsGetView
}
newVaultMattersHoldsGet :: Text -> Text -> VaultMattersHoldsGet

Resource

type VaultMattersHoldsGetResource = "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 "view" MattersHoldsGetView :> (QueryParam "alt" AltJSON :> Get '[JSON] Hold))))))))))) Source #

A resource alias for vault.matters.holds.get method which the VaultMattersHoldsGet request conforms to.

Constructing a Request

data VaultMattersHoldsGet Source #

Gets the specified hold.

See: newVaultMattersHoldsGet smart constructor.

Constructors

VaultMattersHoldsGet

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
holdId :: Text
The hold ID.
matterId :: Text
The matter ID.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").
view :: Maybe MattersHoldsGetView
The amount of detail to return for a hold.

Instances

Instances details

Generic VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

Associated Types

type Rep VaultMattersHoldsGet

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

Methods

from :: VaultMattersHoldsGet -> Rep VaultMattersHoldsGet x #

to :: Rep VaultMattersHoldsGet x -> VaultMattersHoldsGet #

Show VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

Methods

showsPrec :: Int -> VaultMattersHoldsGet -> ShowS #

show :: VaultMattersHoldsGet -> String #

showList :: [VaultMattersHoldsGet] -> ShowS #

Eq VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

Methods

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

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

GoogleRequest VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

Associated Types

type Rs VaultMattersHoldsGet
Instance details Defined in Gogol.Vault.Matters.Holds.Get type Rs VaultMattersHoldsGet = Hold
type Scopes VaultMattersHoldsGet
Instance details Defined in Gogol.Vault.Matters.Holds.Get type Scopes VaultMattersHoldsGet = '[Ediscovery'FullControl, Ediscovery'Readonly]

Methods

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

type Rep VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

type Rs VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

type Rs VaultMattersHoldsGet = Hold

type Scopes VaultMattersHoldsGet Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Get

type Scopes VaultMattersHoldsGet = '[Ediscovery'FullControl, Ediscovery'Readonly]

newVaultMattersHoldsGet Source #

Arguments

:: Text	The hold ID. See `holdId`.
-> Text	The matter ID. See `matterId`.
-> VaultMattersHoldsGet

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