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

Contents

Resource
- Constructing a Request

Description

Lists the holds in a matter.

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

Synopsis

type VaultMattersHoldsListResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "pageSize" Int32 :> (QueryParam "pageToken" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "view" MattersHoldsListView :> (QueryParam "alt" AltJSON :> Get '[JSON] ListHoldsResponse))))))))))))
data VaultMattersHoldsList = VaultMattersHoldsList {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- matterId :: Text
- pageSize :: Maybe Int32
- pageToken :: Maybe Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
- view :: Maybe MattersHoldsListView
}
newVaultMattersHoldsList :: Text -> VaultMattersHoldsList

Resource

type VaultMattersHoldsListResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "pageSize" Int32 :> (QueryParam "pageToken" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "view" MattersHoldsListView :> (QueryParam "alt" AltJSON :> Get '[JSON] ListHoldsResponse)))))))))))) Source #

A resource alias for vault.matters.holds.list method which the VaultMattersHoldsList request conforms to.

Constructing a Request

data VaultMattersHoldsList Source #

Lists the holds in a matter.

See: newVaultMattersHoldsList smart constructor.

Constructors

VaultMattersHoldsList

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
matterId :: Text
The matter ID.
pageSize :: Maybe Int32
The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
pageToken :: Maybe Text
The pagination token as returned in the response. An empty token means start from the beginning.
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 MattersHoldsListView
The amount of detail to return for a hold.

Instances

Instances details

Generic VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

Associated Types

type Rep VaultMattersHoldsList

Instance details

Defined in Gogol.Vault.Matters.Holds.List

Methods

from :: VaultMattersHoldsList -> Rep VaultMattersHoldsList x #

to :: Rep VaultMattersHoldsList x -> VaultMattersHoldsList #

Show VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

Methods

showsPrec :: Int -> VaultMattersHoldsList -> ShowS #

show :: VaultMattersHoldsList -> String #

showList :: [VaultMattersHoldsList] -> ShowS #

Eq VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

Methods

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

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

GoogleRequest VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

Associated Types

type Rs VaultMattersHoldsList
Instance details Defined in Gogol.Vault.Matters.Holds.List type Rs VaultMattersHoldsList = ListHoldsResponse
type Scopes VaultMattersHoldsList
Instance details Defined in Gogol.Vault.Matters.Holds.List type Scopes VaultMattersHoldsList = '[Ediscovery'FullControl, Ediscovery'Readonly]

Methods

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

type Rep VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

type Rs VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

type Rs VaultMattersHoldsList = ListHoldsResponse

type Scopes VaultMattersHoldsList Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.List

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

newVaultMattersHoldsList Source #

Arguments

:: Text	The matter ID. See `matterId`.
-> VaultMattersHoldsList

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