Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- vault.matters.addPermissions
- vault.matters.close
- vault.matters.create
- vault.matters.delete
- vault.matters.exports.create
- vault.matters.exports.delete
- vault.matters.exports.get
- vault.matters.exports.list
- vault.matters.get
- vault.matters.holds.accounts.create
- vault.matters.holds.accounts.delete
- vault.matters.holds.accounts.list
- vault.matters.holds.addHeldAccounts
- vault.matters.holds.create
- vault.matters.holds.delete
- vault.matters.holds.get
- vault.matters.holds.list
- vault.matters.holds.removeHeldAccounts
- vault.matters.holds.update
- vault.matters.list
- vault.matters.removePermissions
- vault.matters.reopen
- vault.matters.savedQueries.create
- vault.matters.savedQueries.delete
- vault.matters.savedQueries.get
- vault.matters.savedQueries.list
- vault.matters.undelete
- vault.matters.update
- Types
- HeldAccount
- HeldHangoutsChatQuery
- ExportOptionsRegion
- Export
- MatterPermissionRole
- Status
- AccountInfo
- CloudStorageSink
- HoldCorpus
- HangoutsChatExportOptions
- UserInfo
- TeamDriveInfo
- AddHeldAccountsRequest
- CorpusQuery
- QueryCorpus
- OrgUnitInfo
- RemoveHeldAccountsResponse
- Empty
- ExportStats
- HangoutsChatInfo
- RemoveHeldAccountsRequest
- HangoutsChatExportOptionsExportFormat
- QueryDataScope
- ListSavedQueriesResponse
- ExportStatus
- UndeleteMatterRequest
- HeldDriveQuery
- HangoutsChatOptions
- QuerySearchMethod
- AddMatterPermissionsRequest
- StatusDetailsItem
- Matter
- CloseMatterResponse
- HeldMailQuery
- ListHeldAccountsResponse
- ListExportsResponse
- HeldOrgUnit
- ListMattersResponse
- ReopenMatterRequest
- RemoveMatterPermissionsRequest
- ExportOptions
- MatterState
- CloseMatterRequest
- DriveOptions
- AddHeldAccountResult
- SavedQuery
- Hold
- GroupsExportOptionsExportFormat
- Query
- Xgafv
- MailExportOptionsExportFormat
- AddHeldAccountsResponse
- MailExportOptions
- ListHoldsResponse
- GroupsExportOptions
- MatterPermission
- DriveExportOptions
- HeldGroupsQuery
- ReopenMatterResponse
- CloudStorageFile
- MailOptions
Archiving and eDiscovery for G Suite.
Synopsis
- vaultService :: ServiceConfig
- ediscoveryReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/ediscovery.readonly"]
- ediscoveryScope :: Proxy '["https://www.googleapis.com/auth/ediscovery"]
- type VaultAPI = MattersSavedQueriesListResource :<|> (MattersSavedQueriesGetResource :<|> (MattersSavedQueriesCreateResource :<|> (MattersSavedQueriesDeleteResource :<|> (MattersHoldsAccountsListResource :<|> (MattersHoldsAccountsCreateResource :<|> (MattersHoldsAccountsDeleteResource :<|> (MattersHoldsListResource :<|> (MattersHoldsGetResource :<|> (MattersHoldsAddHeldAccountsResource :<|> (MattersHoldsRemoveHeldAccountsResource :<|> (MattersHoldsCreateResource :<|> (MattersHoldsDeleteResource :<|> (MattersHoldsUpdateResource :<|> (MattersExportsListResource :<|> (MattersExportsGetResource :<|> (MattersExportsCreateResource :<|> (MattersExportsDeleteResource :<|> (MattersListResource :<|> (MattersUndeleteResource :<|> (MattersGetResource :<|> (MattersCloseResource :<|> (MattersAddPermissionsResource :<|> (MattersCreateResource :<|> (MattersReopenResource :<|> (MattersRemovePermissionsResource :<|> (MattersDeleteResource :<|> MattersUpdateResource))))))))))))))))))))))))))
- module Network.Google.Resource.Vault.Matters.AddPermissions
- module Network.Google.Resource.Vault.Matters.Close
- module Network.Google.Resource.Vault.Matters.Create
- module Network.Google.Resource.Vault.Matters.Delete
- module Network.Google.Resource.Vault.Matters.Exports.Create
- module Network.Google.Resource.Vault.Matters.Exports.Delete
- module Network.Google.Resource.Vault.Matters.Exports.Get
- module Network.Google.Resource.Vault.Matters.Exports.List
- module Network.Google.Resource.Vault.Matters.Get
- module Network.Google.Resource.Vault.Matters.Holds.Accounts.Create
- module Network.Google.Resource.Vault.Matters.Holds.Accounts.Delete
- module Network.Google.Resource.Vault.Matters.Holds.Accounts.List
- module Network.Google.Resource.Vault.Matters.Holds.AddHeldAccounts
- module Network.Google.Resource.Vault.Matters.Holds.Create
- module Network.Google.Resource.Vault.Matters.Holds.Delete
- module Network.Google.Resource.Vault.Matters.Holds.Get
- module Network.Google.Resource.Vault.Matters.Holds.List
- module Network.Google.Resource.Vault.Matters.Holds.RemoveHeldAccounts
- module Network.Google.Resource.Vault.Matters.Holds.Update
- module Network.Google.Resource.Vault.Matters.List
- module Network.Google.Resource.Vault.Matters.RemovePermissions
- module Network.Google.Resource.Vault.Matters.Reopen
- module Network.Google.Resource.Vault.Matters.SavedQueries.Create
- module Network.Google.Resource.Vault.Matters.SavedQueries.Delete
- module Network.Google.Resource.Vault.Matters.SavedQueries.Get
- module Network.Google.Resource.Vault.Matters.SavedQueries.List
- module Network.Google.Resource.Vault.Matters.Undelete
- module Network.Google.Resource.Vault.Matters.Update
- data HeldAccount
- heldAccount :: HeldAccount
- haAccountId :: Lens' HeldAccount (Maybe Text)
- haHoldTime :: Lens' HeldAccount (Maybe UTCTime)
- data HeldHangoutsChatQuery
- heldHangoutsChatQuery :: HeldHangoutsChatQuery
- hhcqIncludeRooms :: Lens' HeldHangoutsChatQuery (Maybe Bool)
- data ExportOptionsRegion
- data Export
- export' :: Export
- eStatus :: Lens' Export (Maybe ExportStatus)
- eCloudStorageSink :: Lens' Export (Maybe CloudStorageSink)
- eMatterId :: Lens' Export (Maybe Text)
- eStats :: Lens' Export (Maybe ExportStats)
- eExportOptions :: Lens' Export (Maybe ExportOptions)
- eName :: Lens' Export (Maybe Text)
- eQuery :: Lens' Export (Maybe Query)
- eId :: Lens' Export (Maybe Text)
- eRequester :: Lens' Export (Maybe UserInfo)
- eCreateTime :: Lens' Export (Maybe UTCTime)
- data MatterPermissionRole
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data AccountInfo
- accountInfo :: AccountInfo
- aiEmails :: Lens' AccountInfo [Text]
- data CloudStorageSink
- cloudStorageSink :: CloudStorageSink
- cssFiles :: Lens' CloudStorageSink [CloudStorageFile]
- data HoldCorpus
- data HangoutsChatExportOptions
- hangoutsChatExportOptions :: HangoutsChatExportOptions
- hceoExportFormat :: Lens' HangoutsChatExportOptions (Maybe HangoutsChatExportOptionsExportFormat)
- data UserInfo
- userInfo :: UserInfo
- uiEmail :: Lens' UserInfo (Maybe Text)
- uiDisplayName :: Lens' UserInfo (Maybe Text)
- data TeamDriveInfo
- teamDriveInfo :: TeamDriveInfo
- tdiTeamDriveIds :: Lens' TeamDriveInfo [Text]
- data AddHeldAccountsRequest
- addHeldAccountsRequest :: AddHeldAccountsRequest
- aharAccountIds :: Lens' AddHeldAccountsRequest [Text]
- aharEmails :: Lens' AddHeldAccountsRequest [Text]
- data CorpusQuery
- corpusQuery :: CorpusQuery
- cqGroupsQuery :: Lens' CorpusQuery (Maybe HeldGroupsQuery)
- cqDriveQuery :: Lens' CorpusQuery (Maybe HeldDriveQuery)
- cqHangoutsChatQuery :: Lens' CorpusQuery (Maybe HeldHangoutsChatQuery)
- cqMailQuery :: Lens' CorpusQuery (Maybe HeldMailQuery)
- data QueryCorpus
- data OrgUnitInfo
- orgUnitInfo :: OrgUnitInfo
- ouiOrgUnitId :: Lens' OrgUnitInfo (Maybe Text)
- data RemoveHeldAccountsResponse
- removeHeldAccountsResponse :: RemoveHeldAccountsResponse
- rharStatuses :: Lens' RemoveHeldAccountsResponse [Status]
- data Empty
- empty :: Empty
- data ExportStats
- exportStats :: ExportStats
- esTotalArtifactCount :: Lens' ExportStats (Maybe Int64)
- esSizeInBytes :: Lens' ExportStats (Maybe Int64)
- esExportedArtifactCount :: Lens' ExportStats (Maybe Int64)
- data HangoutsChatInfo
- hangoutsChatInfo :: HangoutsChatInfo
- hciRoomId :: Lens' HangoutsChatInfo [Text]
- data RemoveHeldAccountsRequest
- removeHeldAccountsRequest :: RemoveHeldAccountsRequest
- rharAccountIds :: Lens' RemoveHeldAccountsRequest [Text]
- data HangoutsChatExportOptionsExportFormat
- data QueryDataScope
- data ListSavedQueriesResponse
- listSavedQueriesResponse :: ListSavedQueriesResponse
- lsqrNextPageToken :: Lens' ListSavedQueriesResponse (Maybe Text)
- lsqrSavedQueries :: Lens' ListSavedQueriesResponse [SavedQuery]
- data ExportStatus
- data UndeleteMatterRequest
- undeleteMatterRequest :: UndeleteMatterRequest
- data HeldDriveQuery
- heldDriveQuery :: HeldDriveQuery
- hdqIncludeTeamDriveFiles :: Lens' HeldDriveQuery (Maybe Bool)
- data HangoutsChatOptions
- hangoutsChatOptions :: HangoutsChatOptions
- hcoIncludeRooms :: Lens' HangoutsChatOptions (Maybe Bool)
- data QuerySearchMethod
- data AddMatterPermissionsRequest
- addMatterPermissionsRequest :: AddMatterPermissionsRequest
- amprSendEmails :: Lens' AddMatterPermissionsRequest (Maybe Bool)
- amprCcMe :: Lens' AddMatterPermissionsRequest (Maybe Bool)
- amprMatterPermission :: Lens' AddMatterPermissionsRequest (Maybe MatterPermission)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data Matter
- matter :: Matter
- mState :: Lens' Matter (Maybe MatterState)
- mMatterPermissions :: Lens' Matter [MatterPermission]
- mMatterId :: Lens' Matter (Maybe Text)
- mName :: Lens' Matter (Maybe Text)
- mDescription :: Lens' Matter (Maybe Text)
- data CloseMatterResponse
- closeMatterResponse :: CloseMatterResponse
- cmrMatter :: Lens' CloseMatterResponse (Maybe Matter)
- data HeldMailQuery
- heldMailQuery :: HeldMailQuery
- hmqStartTime :: Lens' HeldMailQuery (Maybe UTCTime)
- hmqTerms :: Lens' HeldMailQuery (Maybe Text)
- hmqEndTime :: Lens' HeldMailQuery (Maybe UTCTime)
- data ListHeldAccountsResponse
- listHeldAccountsResponse :: ListHeldAccountsResponse
- lharAccounts :: Lens' ListHeldAccountsResponse [HeldAccount]
- data ListExportsResponse
- listExportsResponse :: ListExportsResponse
- lerNextPageToken :: Lens' ListExportsResponse (Maybe Text)
- lerExports :: Lens' ListExportsResponse [Export]
- data HeldOrgUnit
- heldOrgUnit :: HeldOrgUnit
- houHoldTime :: Lens' HeldOrgUnit (Maybe UTCTime)
- houOrgUnitId :: Lens' HeldOrgUnit (Maybe Text)
- data ListMattersResponse
- listMattersResponse :: ListMattersResponse
- lmrNextPageToken :: Lens' ListMattersResponse (Maybe Text)
- lmrMatters :: Lens' ListMattersResponse [Matter]
- data ReopenMatterRequest
- reopenMatterRequest :: ReopenMatterRequest
- data RemoveMatterPermissionsRequest
- removeMatterPermissionsRequest :: RemoveMatterPermissionsRequest
- rmprAccountId :: Lens' RemoveMatterPermissionsRequest (Maybe Text)
- data ExportOptions
- exportOptions :: ExportOptions
- eoHangoutsChatOptions :: Lens' ExportOptions (Maybe HangoutsChatExportOptions)
- eoDriveOptions :: Lens' ExportOptions (Maybe DriveExportOptions)
- eoGroupsOptions :: Lens' ExportOptions (Maybe GroupsExportOptions)
- eoRegion :: Lens' ExportOptions (Maybe ExportOptionsRegion)
- eoMailOptions :: Lens' ExportOptions (Maybe MailExportOptions)
- data MatterState
- data CloseMatterRequest
- closeMatterRequest :: CloseMatterRequest
- data DriveOptions
- driveOptions :: DriveOptions
- doIncludeTeamDrives :: Lens' DriveOptions (Maybe Bool)
- doVersionDate :: Lens' DriveOptions (Maybe UTCTime)
- data AddHeldAccountResult
- addHeldAccountResult :: AddHeldAccountResult
- aharStatus :: Lens' AddHeldAccountResult (Maybe Status)
- aharAccount :: Lens' AddHeldAccountResult (Maybe HeldAccount)
- data SavedQuery
- savedQuery :: SavedQuery
- sqSavedQueryId :: Lens' SavedQuery (Maybe Text)
- sqMatterId :: Lens' SavedQuery (Maybe Text)
- sqQuery :: Lens' SavedQuery (Maybe Query)
- sqDisplayName :: Lens' SavedQuery (Maybe Text)
- sqCreateTime :: Lens' SavedQuery (Maybe UTCTime)
- data Hold
- hold :: Hold
- hOrgUnit :: Lens' Hold (Maybe HeldOrgUnit)
- hHoldId :: Lens' Hold (Maybe Text)
- hAccounts :: Lens' Hold [HeldAccount]
- hUpdateTime :: Lens' Hold (Maybe UTCTime)
- hName :: Lens' Hold (Maybe Text)
- hQuery :: Lens' Hold (Maybe CorpusQuery)
- hCorpus :: Lens' Hold (Maybe HoldCorpus)
- data GroupsExportOptionsExportFormat
- data Query
- query :: Query
- qAccountInfo :: Lens' Query (Maybe AccountInfo)
- qTeamDriveInfo :: Lens' Query (Maybe TeamDriveInfo)
- qOrgUnitInfo :: Lens' Query (Maybe OrgUnitInfo)
- qStartTime :: Lens' Query (Maybe UTCTime)
- qTerms :: Lens' Query (Maybe Text)
- qHangoutsChatInfo :: Lens' Query (Maybe HangoutsChatInfo)
- qHangoutsChatOptions :: Lens' Query (Maybe HangoutsChatOptions)
- qDriveOptions :: Lens' Query (Maybe DriveOptions)
- qEndTime :: Lens' Query (Maybe UTCTime)
- qDataScope :: Lens' Query (Maybe QueryDataScope)
- qCorpus :: Lens' Query (Maybe QueryCorpus)
- qTimeZone :: Lens' Query (Maybe Text)
- qMailOptions :: Lens' Query (Maybe MailOptions)
- qSearchMethod :: Lens' Query (Maybe QuerySearchMethod)
- data Xgafv
- data MailExportOptionsExportFormat
- data AddHeldAccountsResponse
- addHeldAccountsResponse :: AddHeldAccountsResponse
- aharResponses :: Lens' AddHeldAccountsResponse [AddHeldAccountResult]
- data MailExportOptions
- mailExportOptions :: MailExportOptions
- meoExportFormat :: Lens' MailExportOptions (Maybe MailExportOptionsExportFormat)
- data ListHoldsResponse
- listHoldsResponse :: ListHoldsResponse
- lhrNextPageToken :: Lens' ListHoldsResponse (Maybe Text)
- lhrHolds :: Lens' ListHoldsResponse [Hold]
- data GroupsExportOptions
- groupsExportOptions :: GroupsExportOptions
- geoExportFormat :: Lens' GroupsExportOptions (Maybe GroupsExportOptionsExportFormat)
- data MatterPermission
- matterPermission :: MatterPermission
- mpRole :: Lens' MatterPermission (Maybe MatterPermissionRole)
- mpAccountId :: Lens' MatterPermission (Maybe Text)
- data DriveExportOptions
- driveExportOptions :: DriveExportOptions
- deoIncludeAccessInfo :: Lens' DriveExportOptions (Maybe Bool)
- data HeldGroupsQuery
- heldGroupsQuery :: HeldGroupsQuery
- hgqStartTime :: Lens' HeldGroupsQuery (Maybe UTCTime)
- hgqTerms :: Lens' HeldGroupsQuery (Maybe Text)
- hgqEndTime :: Lens' HeldGroupsQuery (Maybe UTCTime)
- data ReopenMatterResponse
- reopenMatterResponse :: ReopenMatterResponse
- rmrMatter :: Lens' ReopenMatterResponse (Maybe Matter)
- data CloudStorageFile
- cloudStorageFile :: CloudStorageFile
- csfObjectName :: Lens' CloudStorageFile (Maybe Text)
- csfSize :: Lens' CloudStorageFile (Maybe Int64)
- csfBucketName :: Lens' CloudStorageFile (Maybe Text)
- csfMD5Hash :: Lens' CloudStorageFile (Maybe Text)
- data MailOptions
- mailOptions :: MailOptions
- moExcludeDrafts :: Lens' MailOptions (Maybe Bool)
Service Configuration
vaultService :: ServiceConfig Source #
Default request referring to version v1
of the G Suite Vault API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
ediscoveryReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/ediscovery.readonly"] Source #
View your eDiscovery data
ediscoveryScope :: Proxy '["https://www.googleapis.com/auth/ediscovery"] Source #
Manage your eDiscovery data
API Declaration
type VaultAPI = MattersSavedQueriesListResource :<|> (MattersSavedQueriesGetResource :<|> (MattersSavedQueriesCreateResource :<|> (MattersSavedQueriesDeleteResource :<|> (MattersHoldsAccountsListResource :<|> (MattersHoldsAccountsCreateResource :<|> (MattersHoldsAccountsDeleteResource :<|> (MattersHoldsListResource :<|> (MattersHoldsGetResource :<|> (MattersHoldsAddHeldAccountsResource :<|> (MattersHoldsRemoveHeldAccountsResource :<|> (MattersHoldsCreateResource :<|> (MattersHoldsDeleteResource :<|> (MattersHoldsUpdateResource :<|> (MattersExportsListResource :<|> (MattersExportsGetResource :<|> (MattersExportsCreateResource :<|> (MattersExportsDeleteResource :<|> (MattersListResource :<|> (MattersUndeleteResource :<|> (MattersGetResource :<|> (MattersCloseResource :<|> (MattersAddPermissionsResource :<|> (MattersCreateResource :<|> (MattersReopenResource :<|> (MattersRemovePermissionsResource :<|> (MattersDeleteResource :<|> MattersUpdateResource)))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the G Suite Vault API service.
Resources
vault.matters.addPermissions
vault.matters.close
vault.matters.create
vault.matters.delete
vault.matters.exports.create
vault.matters.exports.delete
vault.matters.exports.get
vault.matters.exports.list
vault.matters.get
vault.matters.holds.accounts.create
vault.matters.holds.accounts.delete
vault.matters.holds.accounts.list
vault.matters.holds.addHeldAccounts
vault.matters.holds.create
vault.matters.holds.delete
vault.matters.holds.get
vault.matters.holds.list
vault.matters.holds.removeHeldAccounts
vault.matters.holds.update
vault.matters.list
vault.matters.removePermissions
vault.matters.reopen
vault.matters.savedQueries.create
vault.matters.savedQueries.delete
vault.matters.savedQueries.get
vault.matters.savedQueries.list
vault.matters.undelete
vault.matters.update
Types
HeldAccount
data HeldAccount Source #
An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
See: heldAccount
smart constructor.
Instances
heldAccount :: HeldAccount Source #
Creates a value of HeldAccount
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
haAccountId :: Lens' HeldAccount (Maybe Text) Source #
The account's ID as provided by the Admin SDK.
haHoldTime :: Lens' HeldAccount (Maybe UTCTime) Source #
When the account was put on hold.
HeldHangoutsChatQuery
data HeldHangoutsChatQuery Source #
Query options for hangouts chat holds.
See: heldHangoutsChatQuery
smart constructor.
Instances
heldHangoutsChatQuery :: HeldHangoutsChatQuery Source #
Creates a value of HeldHangoutsChatQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hhcqIncludeRooms :: Lens' HeldHangoutsChatQuery (Maybe Bool) Source #
If true, include rooms the user has participated in.
ExportOptionsRegion
data ExportOptionsRegion Source #
The requested export location.
ExportRegionUnspecified |
|
Any |
|
US |
|
Europe |
|
Instances
Export
An export
See: export'
smart constructor.
Instances
Creates a value of Export
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eCloudStorageSink :: Lens' Export (Maybe CloudStorageSink) Source #
Output only. Export sink for cloud storage files.
eExportOptions :: Lens' Export (Maybe ExportOptions) Source #
Advanced options of the export.
eCreateTime :: Lens' Export (Maybe UTCTime) Source #
Output only. The time when the export was created.
MatterPermissionRole
data MatterPermissionRole Source #
The user's role in this matter.
RoleUnspecified |
|
Collaborator |
|
Owner |
|
Instances
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.Vault.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.Vault.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.Vault.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.Vault.Types.Product" "gogol-vault-0.4.0-EgDnYDp2TSnGyXDp2UEGmS" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
AccountInfo
data AccountInfo Source #
Accounts to search
See: accountInfo
smart constructor.
Instances
accountInfo :: AccountInfo Source #
Creates a value of AccountInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CloudStorageSink
data CloudStorageSink Source #
Export sink for cloud storage files.
See: cloudStorageSink
smart constructor.
Instances
cloudStorageSink :: CloudStorageSink Source #
Creates a value of CloudStorageSink
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cssFiles :: Lens' CloudStorageSink [CloudStorageFile] Source #
Output only. The exported files on cloud storage.
HoldCorpus
data HoldCorpus Source #
The corpus to be searched.
CorpusTypeUnspecified |
|
Drive |
|
| |
Groups |
|
HangoutsChat |
|
Instances
HangoutsChatExportOptions
data HangoutsChatExportOptions Source #
The options for hangouts chat export.
See: hangoutsChatExportOptions
smart constructor.
Instances
hangoutsChatExportOptions :: HangoutsChatExportOptions Source #
Creates a value of HangoutsChatExportOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hceoExportFormat :: Lens' HangoutsChatExportOptions (Maybe HangoutsChatExportOptionsExportFormat) Source #
The export format for hangouts chat export.
UserInfo
User's information.
See: userInfo
smart constructor.
Instances
Eq UserInfo Source # | |
Data UserInfo Source # | |
Defined in Network.Google.Vault.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserInfo -> c UserInfo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserInfo # toConstr :: UserInfo -> Constr # dataTypeOf :: UserInfo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserInfo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserInfo) # gmapT :: (forall b. Data b => b -> b) -> UserInfo -> UserInfo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserInfo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserInfo -> r # gmapQ :: (forall d. Data d => d -> u) -> UserInfo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UserInfo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserInfo -> m UserInfo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserInfo -> m UserInfo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserInfo -> m UserInfo # | |
Show UserInfo Source # | |
Generic UserInfo Source # | |
ToJSON UserInfo Source # | |
Defined in Network.Google.Vault.Types.Product | |
FromJSON UserInfo Source # | |
type Rep UserInfo Source # | |
Defined in Network.Google.Vault.Types.Product type Rep UserInfo = D1 (MetaData "UserInfo" "Network.Google.Vault.Types.Product" "gogol-vault-0.4.0-EgDnYDp2TSnGyXDp2UEGmS" False) (C1 (MetaCons "UserInfo'" PrefixI True) (S1 (MetaSel (Just "_uiEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uiDisplayName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
Creates a value of UserInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
TeamDriveInfo
data TeamDriveInfo Source #
Team Drives to search
See: teamDriveInfo
smart constructor.
Instances
teamDriveInfo :: TeamDriveInfo Source #
Creates a value of TeamDriveInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdiTeamDriveIds :: Lens' TeamDriveInfo [Text] Source #
List of Team Drive ids, as provided by Drive API.
AddHeldAccountsRequest
data AddHeldAccountsRequest Source #
Add a list of accounts to a hold.
See: addHeldAccountsRequest
smart constructor.
Instances
addHeldAccountsRequest :: AddHeldAccountsRequest Source #
Creates a value of AddHeldAccountsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aharAccountIds :: Lens' AddHeldAccountsRequest [Text] Source #
Account ids to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
aharEmails :: Lens' AddHeldAccountsRequest [Text] Source #
Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.
CorpusQuery
data CorpusQuery Source #
Corpus specific queries.
See: corpusQuery
smart constructor.
Instances
corpusQuery :: CorpusQuery Source #
Creates a value of CorpusQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cqGroupsQuery :: Lens' CorpusQuery (Maybe HeldGroupsQuery) Source #
Details pertaining to Groups holds. If set, corpus must be Groups.
cqDriveQuery :: Lens' CorpusQuery (Maybe HeldDriveQuery) Source #
Details pertaining to Drive holds. If set, corpus must be Drive.
cqHangoutsChatQuery :: Lens' CorpusQuery (Maybe HeldHangoutsChatQuery) Source #
Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
cqMailQuery :: Lens' CorpusQuery (Maybe HeldMailQuery) Source #
Details pertaining to mail holds. If set, corpus must be mail.
QueryCorpus
data QueryCorpus Source #
The corpus to search.
QCCorpusTypeUnspecified |
|
QCDrive |
|
QCMail |
|
QCGroups |
|
QCHangoutsChat |
|
Instances
OrgUnitInfo
data OrgUnitInfo Source #
Org Unit to search
See: orgUnitInfo
smart constructor.
Instances
orgUnitInfo :: OrgUnitInfo Source #
Creates a value of OrgUnitInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ouiOrgUnitId :: Lens' OrgUnitInfo (Maybe Text) Source #
Org unit to search, as provided by the Admin SDK Directory API.
RemoveHeldAccountsResponse
data RemoveHeldAccountsResponse Source #
Response for batch delete held accounts.
See: removeHeldAccountsResponse
smart constructor.
Instances
removeHeldAccountsResponse :: RemoveHeldAccountsResponse Source #
Creates a value of RemoveHeldAccountsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rharStatuses :: Lens' RemoveHeldAccountsResponse [Status] Source #
A list of statuses for deleted accounts. Results have the same order as the request.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.Vault.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.Vault.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
ExportStats
data ExportStats Source #
Stats of an export.
See: exportStats
smart constructor.
Instances
exportStats :: ExportStats Source #
Creates a value of ExportStats
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esTotalArtifactCount :: Lens' ExportStats (Maybe Int64) Source #
The number of documents to be exported.
esSizeInBytes :: Lens' ExportStats (Maybe Int64) Source #
The size of export in bytes.
esExportedArtifactCount :: Lens' ExportStats (Maybe Int64) Source #
The number of documents already processed by the export.
HangoutsChatInfo
data HangoutsChatInfo Source #
Accounts to search
See: hangoutsChatInfo
smart constructor.
Instances
hangoutsChatInfo :: HangoutsChatInfo Source #
Creates a value of HangoutsChatInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RemoveHeldAccountsRequest
data RemoveHeldAccountsRequest Source #
Remove a list of accounts from a hold.
See: removeHeldAccountsRequest
smart constructor.
Instances
removeHeldAccountsRequest :: RemoveHeldAccountsRequest Source #
Creates a value of RemoveHeldAccountsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rharAccountIds :: Lens' RemoveHeldAccountsRequest [Text] Source #
Account ids to identify HeldAccounts to remove.
HangoutsChatExportOptionsExportFormat
data HangoutsChatExportOptionsExportFormat Source #
The export format for hangouts chat export.
ExportFormatUnspecified |
|
Mbox |
|
Pst |
|
Instances
QueryDataScope
data QueryDataScope Source #
The data source to search from.
DataScopeUnspecified |
|
AllData |
|
HeldData |
|
UnprocessedData |
|
Instances
ListSavedQueriesResponse
data ListSavedQueriesResponse Source #
Definition of the response for method ListSaveQuery.
See: listSavedQueriesResponse
smart constructor.
Instances
listSavedQueriesResponse :: ListSavedQueriesResponse Source #
Creates a value of ListSavedQueriesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsqrNextPageToken :: Lens' ListSavedQueriesResponse (Maybe Text) Source #
Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list.
lsqrSavedQueries :: Lens' ListSavedQueriesResponse [SavedQuery] Source #
List of output saved queries.
ExportStatus
data ExportStatus Source #
Output only. The export status.
ExportStatusUnspecified |
|
Completed |
|
Failed |
|
InProgress |
|
Instances
UndeleteMatterRequest
data UndeleteMatterRequest Source #
Undelete a matter by ID.
See: undeleteMatterRequest
smart constructor.
Instances
undeleteMatterRequest :: UndeleteMatterRequest Source #
Creates a value of UndeleteMatterRequest
with the minimum fields required to make a request.
HeldDriveQuery
data HeldDriveQuery Source #
Query options for Drive holds.
See: heldDriveQuery
smart constructor.
Instances
heldDriveQuery :: HeldDriveQuery Source #
Creates a value of HeldDriveQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hdqIncludeTeamDriveFiles :: Lens' HeldDriveQuery (Maybe Bool) Source #
If true, include files in Team Drives in the hold.
HangoutsChatOptions
data HangoutsChatOptions Source #
Hangouts chat search advanced options
See: hangoutsChatOptions
smart constructor.
Instances
hangoutsChatOptions :: HangoutsChatOptions Source #
Creates a value of HangoutsChatOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hcoIncludeRooms :: Lens' HangoutsChatOptions (Maybe Bool) Source #
Set to true to include rooms.
QuerySearchMethod
data QuerySearchMethod Source #
The search method to use.
SearchMethodUnspecified |
|
Account |
|
OrgUnit |
|
TeamDrive |
|
EntireOrg |
|
Room |
|
Instances
AddMatterPermissionsRequest
data AddMatterPermissionsRequest Source #
Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.
See: addMatterPermissionsRequest
smart constructor.
Instances
addMatterPermissionsRequest :: AddMatterPermissionsRequest Source #
Creates a value of AddMatterPermissionsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
amprSendEmails :: Lens' AddMatterPermissionsRequest (Maybe Bool) Source #
True to send notification email to the added account. False to not send notification email.
amprCcMe :: Lens' AddMatterPermissionsRequest (Maybe Bool) Source #
Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.
amprMatterPermission :: Lens' AddMatterPermissionsRequest (Maybe MatterPermission) Source #
The MatterPermission to add.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
Matter
Represents a matter.
See: matter
smart constructor.
Instances
Eq Matter Source # | |
Data Matter Source # | |
Defined in Network.Google.Vault.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Matter -> c Matter # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Matter # toConstr :: Matter -> Constr # dataTypeOf :: Matter -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Matter) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Matter) # gmapT :: (forall b. Data b => b -> b) -> Matter -> Matter # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Matter -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Matter -> r # gmapQ :: (forall d. Data d => d -> u) -> Matter -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Matter -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Matter -> m Matter # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Matter -> m Matter # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Matter -> m Matter # | |
Show Matter Source # | |
Generic Matter Source # | |
ToJSON Matter Source # | |
Defined in Network.Google.Vault.Types.Product | |
FromJSON Matter Source # | |
type Rep Matter Source # | |
Defined in Network.Google.Vault.Types.Product type Rep Matter = D1 (MetaData "Matter" "Network.Google.Vault.Types.Product" "gogol-vault-0.4.0-EgDnYDp2TSnGyXDp2UEGmS" False) (C1 (MetaCons "Matter'" PrefixI True) ((S1 (MetaSel (Just "_mState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MatterState)) :*: S1 (MetaSel (Just "_mMatterPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MatterPermission]))) :*: (S1 (MetaSel (Just "_mMatterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) |
Creates a value of Matter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMatterPermissions :: Lens' Matter [MatterPermission] Source #
List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
mMatterId :: Lens' Matter (Maybe Text) Source #
The matter ID which is generated by the server. Should be blank when creating a new matter.
CloseMatterResponse
data CloseMatterResponse Source #
Response to a CloseMatterRequest.
See: closeMatterResponse
smart constructor.
Instances
closeMatterResponse :: CloseMatterResponse Source #
Creates a value of CloseMatterResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmrMatter :: Lens' CloseMatterResponse (Maybe Matter) Source #
The updated matter, with state CLOSED.
HeldMailQuery
data HeldMailQuery Source #
Query options for mail holds.
See: heldMailQuery
smart constructor.
Instances
heldMailQuery :: HeldMailQuery Source #
Creates a value of HeldMailQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hmqStartTime :: Lens' HeldMailQuery (Maybe UTCTime) Source #
The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
hmqEndTime :: Lens' HeldMailQuery (Maybe UTCTime) Source #
The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
ListHeldAccountsResponse
data ListHeldAccountsResponse Source #
Returns a list of held accounts for a hold.
See: listHeldAccountsResponse
smart constructor.
Instances
listHeldAccountsResponse :: ListHeldAccountsResponse Source #
Creates a value of ListHeldAccountsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lharAccounts :: Lens' ListHeldAccountsResponse [HeldAccount] Source #
The held accounts on a hold.
ListExportsResponse
data ListExportsResponse Source #
The holds for a matter.
See: listExportsResponse
smart constructor.
Instances
listExportsResponse :: ListExportsResponse Source #
Creates a value of ListExportsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lerNextPageToken :: Lens' ListExportsResponse (Maybe Text) Source #
Page token to retrieve the next page of results in the list.
lerExports :: Lens' ListExportsResponse [Export] Source #
The list of exports.
HeldOrgUnit
data HeldOrgUnit Source #
A organizational unit being held in a particular hold. This structure is immutable.
See: heldOrgUnit
smart constructor.
Instances
heldOrgUnit :: HeldOrgUnit Source #
Creates a value of HeldOrgUnit
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
houHoldTime :: Lens' HeldOrgUnit (Maybe UTCTime) Source #
When the org unit was put on hold. This property is immutable.
houOrgUnitId :: Lens' HeldOrgUnit (Maybe Text) Source #
The org unit's immutable ID as provided by the Admin SDK.
ListMattersResponse
data ListMattersResponse Source #
Provides the list of matters.
See: listMattersResponse
smart constructor.
Instances
listMattersResponse :: ListMattersResponse Source #
Creates a value of ListMattersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrNextPageToken :: Lens' ListMattersResponse (Maybe Text) Source #
Page token to retrieve the next page of results in the list.
lmrMatters :: Lens' ListMattersResponse [Matter] Source #
List of matters.
ReopenMatterRequest
data ReopenMatterRequest Source #
Reopen a matter by ID.
See: reopenMatterRequest
smart constructor.
Instances
reopenMatterRequest :: ReopenMatterRequest Source #
Creates a value of ReopenMatterRequest
with the minimum fields required to make a request.
RemoveMatterPermissionsRequest
data RemoveMatterPermissionsRequest Source #
Remove an account as a matter collaborator.
See: removeMatterPermissionsRequest
smart constructor.
Instances
removeMatterPermissionsRequest :: RemoveMatterPermissionsRequest Source #
Creates a value of RemoveMatterPermissionsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmprAccountId :: Lens' RemoveMatterPermissionsRequest (Maybe Text) Source #
The account ID.
ExportOptions
data ExportOptions Source #
Export advanced options
See: exportOptions
smart constructor.
Instances
exportOptions :: ExportOptions Source #
Creates a value of ExportOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eoHangoutsChatOptions :: Lens' ExportOptions (Maybe HangoutsChatExportOptions) Source #
Option available for hangouts chat export.
eoDriveOptions :: Lens' ExportOptions (Maybe DriveExportOptions) Source #
Option available for Drive export.
eoGroupsOptions :: Lens' ExportOptions (Maybe GroupsExportOptions) Source #
Option available for groups export.
eoRegion :: Lens' ExportOptions (Maybe ExportOptionsRegion) Source #
The requested export location.
eoMailOptions :: Lens' ExportOptions (Maybe MailExportOptions) Source #
Option available for mail export.
MatterState
data MatterState Source #
The state of the matter.
StateUnspecified |
|
Open |
|
Closed |
|
Deleted |
|
Instances
CloseMatterRequest
data CloseMatterRequest Source #
Close a matter by ID.
See: closeMatterRequest
smart constructor.
Instances
closeMatterRequest :: CloseMatterRequest Source #
Creates a value of CloseMatterRequest
with the minimum fields required to make a request.
DriveOptions
data DriveOptions Source #
Drive search advanced options
See: driveOptions
smart constructor.
Instances
driveOptions :: DriveOptions Source #
Creates a value of DriveOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
doIncludeTeamDrives :: Lens' DriveOptions (Maybe Bool) Source #
Set to true to include Team Drive.
doVersionDate :: Lens' DriveOptions (Maybe UTCTime) Source #
Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
AddHeldAccountResult
data AddHeldAccountResult Source #
A status detailing the status of each account creation, and the HeldAccount, if successful.
See: addHeldAccountResult
smart constructor.
Instances
addHeldAccountResult :: AddHeldAccountResult Source #
Creates a value of AddHeldAccountResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aharStatus :: Lens' AddHeldAccountResult (Maybe Status) Source #
This represents the success status. If failed, check message.
aharAccount :: Lens' AddHeldAccountResult (Maybe HeldAccount) Source #
If present, this account was successfully created.
SavedQuery
data SavedQuery Source #
Definition of the saved query.
See: savedQuery
smart constructor.
Instances
savedQuery :: SavedQuery Source #
Creates a value of SavedQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sqSavedQueryId :: Lens' SavedQuery (Maybe Text) Source #
A unique identifier for the saved query.
sqMatterId :: Lens' SavedQuery (Maybe Text) Source #
Output only. The matter id of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
sqQuery :: Lens' SavedQuery (Maybe Query) Source #
The underlying Query object which contains all the information of the saved query.
sqDisplayName :: Lens' SavedQuery (Maybe Text) Source #
Name of the saved query.
sqCreateTime :: Lens' SavedQuery (Maybe UTCTime) Source #
Output only. The server generated timestamp at which saved query was created.
Hold
Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
See: hold
smart constructor.
Instances
hOrgUnit :: Lens' Hold (Maybe HeldOrgUnit) Source #
If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.
hHoldId :: Lens' Hold (Maybe Text) Source #
The unique immutable ID of the hold. Assigned during creation.
hAccounts :: Lens' Hold [HeldAccount] Source #
If set, the hold applies to the enumerated accounts and org_unit must be empty.
hQuery :: Lens' Hold (Maybe CorpusQuery) Source #
The corpus-specific query. If set, the corpusQuery must match corpus type.
GroupsExportOptionsExportFormat
data GroupsExportOptionsExportFormat Source #
The export format for groups export.
GEOEFExportFormatUnspecified |
|
GEOEFMbox |
|
GEOEFPst |
|
Instances
Query
A query definition relevant for search & export.
See: query
smart constructor.
Instances
Creates a value of Query
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qAccountInfo :: Lens' Query (Maybe AccountInfo) Source #
When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
qTeamDriveInfo :: Lens' Query (Maybe TeamDriveInfo) Source #
When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
qOrgUnitInfo :: Lens' Query (Maybe OrgUnitInfo) Source #
When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
qStartTime :: Lens' Query (Maybe UTCTime) Source #
The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
qTerms :: Lens' Query (Maybe Text) Source #
The corpus-specific search operators used to generate search results.
qHangoutsChatInfo :: Lens' Query (Maybe HangoutsChatInfo) Source #
When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
qHangoutsChatOptions :: Lens' Query (Maybe HangoutsChatOptions) Source #
For hangouts chat search, specify more options in this field. (read-only)
qDriveOptions :: Lens' Query (Maybe DriveOptions) Source #
For Drive search, specify more options in this field.
qEndTime :: Lens' Query (Maybe UTCTime) Source #
The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
qDataScope :: Lens' Query (Maybe QueryDataScope) Source #
The data source to search from.
qTimeZone :: Lens' Query (Maybe Text) Source #
The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
qMailOptions :: Lens' Query (Maybe MailOptions) Source #
For mail search, specify more options in this field.
qSearchMethod :: Lens' Query (Maybe QuerySearchMethod) Source #
The search method to use.
Xgafv
V1 error format.
Instances
MailExportOptionsExportFormat
data MailExportOptionsExportFormat Source #
The export file format.
MEOEFExportFormatUnspecified |
|
MEOEFMbox |
|
MEOEFPst |
|
Instances
AddHeldAccountsResponse
data AddHeldAccountsResponse Source #
Response for batch create held accounts.
See: addHeldAccountsResponse
smart constructor.
Instances
addHeldAccountsResponse :: AddHeldAccountsResponse Source #
Creates a value of AddHeldAccountsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aharResponses :: Lens' AddHeldAccountsResponse [AddHeldAccountResult] Source #
The list of responses, in the same order as the batch request.
MailExportOptions
data MailExportOptions Source #
The options for mail export.
See: mailExportOptions
smart constructor.
Instances
mailExportOptions :: MailExportOptions Source #
Creates a value of MailExportOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
meoExportFormat :: Lens' MailExportOptions (Maybe MailExportOptionsExportFormat) Source #
The export file format.
ListHoldsResponse
data ListHoldsResponse Source #
The holds for a matter.
See: listHoldsResponse
smart constructor.
Instances
listHoldsResponse :: ListHoldsResponse Source #
Creates a value of ListHoldsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lhrNextPageToken :: Lens' ListHoldsResponse (Maybe Text) Source #
Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
GroupsExportOptions
data GroupsExportOptions Source #
The options for groups export.
See: groupsExportOptions
smart constructor.
Instances
groupsExportOptions :: GroupsExportOptions Source #
Creates a value of GroupsExportOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
geoExportFormat :: Lens' GroupsExportOptions (Maybe GroupsExportOptionsExportFormat) Source #
The export format for groups export.
MatterPermission
data MatterPermission Source #
Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
See: matterPermission
smart constructor.
Instances
matterPermission :: MatterPermission Source #
Creates a value of MatterPermission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mpRole :: Lens' MatterPermission (Maybe MatterPermissionRole) Source #
The user's role in this matter.
mpAccountId :: Lens' MatterPermission (Maybe Text) Source #
The account id, as provided by Admin SDK.
DriveExportOptions
data DriveExportOptions Source #
The options for Drive export.
See: driveExportOptions
smart constructor.
Instances
driveExportOptions :: DriveExportOptions Source #
Creates a value of DriveExportOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deoIncludeAccessInfo :: Lens' DriveExportOptions (Maybe Bool) Source #
Set to true to include access level information for users with indirect access to files.
HeldGroupsQuery
data HeldGroupsQuery Source #
Query options for group holds.
See: heldGroupsQuery
smart constructor.
Instances
heldGroupsQuery :: HeldGroupsQuery Source #
Creates a value of HeldGroupsQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hgqStartTime :: Lens' HeldGroupsQuery (Maybe UTCTime) Source #
The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
hgqEndTime :: Lens' HeldGroupsQuery (Maybe UTCTime) Source #
The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
ReopenMatterResponse
data ReopenMatterResponse Source #
Response to a ReopenMatterRequest.
See: reopenMatterResponse
smart constructor.
Instances
reopenMatterResponse :: ReopenMatterResponse Source #
Creates a value of ReopenMatterResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CloudStorageFile
data CloudStorageFile Source #
An export file on cloud storage
See: cloudStorageFile
smart constructor.
Instances
cloudStorageFile :: CloudStorageFile Source #
Creates a value of CloudStorageFile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csfObjectName :: Lens' CloudStorageFile (Maybe Text) Source #
The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API.
csfBucketName :: Lens' CloudStorageFile (Maybe Text) Source #
The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API.
csfMD5Hash :: Lens' CloudStorageFile (Maybe Text) Source #
The md5 hash of the file.
MailOptions
data MailOptions Source #
Mail search advanced options
See: mailOptions
smart constructor.
Instances
mailOptions :: MailOptions Source #
Creates a value of MailOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
moExcludeDrafts :: Lens' MailOptions (Maybe Bool) Source #
Set to true to exclude drafts.