vault.v1 library Null safety

Google Vault API - v1

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the required Vault privileges and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the View All Matters privilege. For example, to download an export, an account needs the Manage Exports privilege and the matter shared with them.

For more information, see developers.google.com/vault

Create an instance of VaultApi to access these resources:

Classes

AccountCount
The results count for each account.
AccountCountError
An error that occurred when querying a specific account
AccountInfo
The accounts to search
AddHeldAccountResult
The status of each account creation, and the HeldAccount, if successful.
AddHeldAccountsRequest
Add a list of accounts to a hold.
AddHeldAccountsResponse
Response for batch create held accounts.
AddMatterPermissionsRequest
Add an account with the permission specified. [...]
CloseMatterResponse
Response to a CloseMatterRequest.
CloudStorageFile
The export file in Cloud Storage
CloudStorageSink
Export sink for Cloud Storage files.
CorpusQuery
Service-specific options for holds.
CountArtifactsMetadata
Long running operation metadata for CountArtifacts.
CountArtifactsRequest
Count artifacts request.
CountArtifactsResponse
Definition of the response for method CountArtifacts.
DriveExportOptions
Options for Drive exports.
DriveOptions
Additional options for Drive search
Export
An export. [...]
ExportOptions
Additional options for exports
ExportStats
Progress information for an export.
GroupsCountResult
Groups specific count metrics.
HangoutsChatInfo
The Chat spaces to search
HangoutsChatOptions
Additional options for Google Chat search
HeldAccount
An account covered by a hold. [...]
HeldDriveQuery
Options for Drive holds.
HeldHangoutsChatQuery
Options for Chat holds.
HeldOrgUnit
The organizational unit covered by a hold. [...]
HeldVoiceQuery
Options for Voice holds.
Hold
A hold. [...]
ListExportsResponse
The exports for a matter.
ListHeldAccountsResponse
Returns a list of the accounts covered by a hold.
ListHoldsResponse
The holds for a matter.
ListMattersResponse
Provides the list of matters.
ListOperationsResponse
The response message for Operations.ListOperations.
ListSavedQueriesResponse
Definition of the response for method ListSaveQuery.
MailCountResult
Gmail and classic Hangouts-specific count metrics.
MailExportOptions
Options for Gmail exports.
MailOptions
Additional options for Gmail search
Matter
Represents a matter. [...]
MatterPermission
Users can be matter owners or collaborators. [...]
MattersExportsResource
MattersHoldsAccountsResource
MattersHoldsResource
MattersResource
MattersSavedQueriesResource
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationsResource
OrgUnitInfo
The organizational unit to search
Query
The query definition used for search and export.
RemoveHeldAccountsRequest
Remove a list of accounts from a hold.
RemoveHeldAccountsResponse
Response for batch delete held accounts.
RemoveMatterPermissionsRequest
Remove an account as a matter collaborator.
ReopenMatterResponse
Response to a ReopenMatterRequest.
SavedQuery
The definition of a saved query. [...]
SharedDriveInfo
The shared drives to search
TeamDriveInfo
Team Drives to search
UserInfo
User's information.
VaultApi
Retention and eDiscovery for Google Workspace. [...]
VoiceExportOptions
The options for Voice exports.
VoiceOptions
Additional options for Voice search

Typedefs

CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
CloseMatterRequest = $Empty
Close a matter by ID.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GroupsExportOptions = $ExportOptions
Options for Groups exports.
HangoutsChatExportOptions = $ExportOptions
Options for Chat exports.
HeldGroupsQuery = $Query
Query options for group holds.
HeldMailQuery = $Query
Query options for Gmail holds.
ReopenMatterRequest = $Empty
Reopen a matter by ID.
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
UndeleteMatterRequest = $Empty
Undelete a matter by ID.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.