Module googleapis.vault
ballerinax/googleapis.vault Ballerina library
1.5.2
Overview
The Google Vault API v1 connector(https://developers.google.com/vault/reference/rest) OpenAPI specification. The Google Vault API provides the capability to perform eDiscovery tasks, search, hold, and export data of interest.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Google Workspace account
- Obtain tokens - Follow this guide
Clients
googleapis.vault: Client
Isolated
This is a generated connector for Google Vault API v1 OpenAPI specification. The Google Vault API provides the capability to do 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.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a Google Workspace account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://vault.googleapis.com/" - URL of the target service
listMatters
Isolated FunctionRemote Function
function listMatters(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken, string? state, string? view) returns ListMattersResponse|errorLists matters the requestor has access to.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - The number of matters to return in the response. Default and maximum are 100.
- pageToken string? (default ()) - The pagination token as returned in the response.
- state string? (default ()) - If set, lists only matters with the specified state. The default lists matters of all states.
- view string? (default ()) - Specifies how much information about the matter to return in response.
Return Type
- ListMattersResponse|error - Successful response
createVaultMatter
Isolated FunctionRemote Function
function createVaultMatter(Matter payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Matter|errorCreates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
Parameters
- payload Matter - Matter to be created
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
getMatter
Isolated FunctionRemote Function
function getMatter(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? view) returns Matter|errorGets the specified matter.
Parameters
- matterId string - The matter ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- view string? (default ()) - Specifies how much information about the matter to return in the response.
updateMatter
Isolated FunctionRemote Function
function updateMatter(string matterId, Matter payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Matter|errorUpdates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.
Parameters
- matterId string - The matter ID.
- payload Matter - Matter to be updated
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
deleteMatter
Isolated FunctionRemote Function
function deleteMatter(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Matter|errorDeletes the specified matter. Returns the matter with updated state.
Parameters
- matterId string - The matter ID
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
listExports
Isolated FunctionRemote Function
function listExports(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListExportsResponse|errorLists details about the exports in the specified matter.
Parameters
- matterId string - The matter ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - The number of exports to return in the response.
- pageToken string? (default ()) - The pagination token as returned in the response.
Return Type
- ListExportsResponse|error - Successful response
createExport
Isolated FunctionRemote Function
function createExport(string matterId, Export payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Export|errorCreates an export.
Parameters
- matterId string - The matter ID.
- payload Export - Export to be created
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
getExport
Isolated FunctionRemote Function
function getExport(string matterId, string exportId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Export|errorGets an export.
Parameters
- matterId string - The matter ID.
- exportId string - The export ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
deleteExport
Isolated FunctionRemote Function
function deleteExport(string matterId, string exportId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorDeletes an export.
Parameters
- matterId string - The matter ID.
- exportId string - The export ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
listHolds
Isolated FunctionRemote Function
function listHolds(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken, string? view) returns ListHoldsResponse|errorLists the holds in a matter.
Parameters
- matterId string - The matter ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - 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 string? (default ()) - The pagination token as returned in the response. An empty token means start from the beginning.
- view string? (default ()) - The amount of detail to return for a hold.
Return Type
- ListHoldsResponse|error - Successful response
createHold
Isolated FunctionRemote Function
function createHold(string matterId, Hold payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Hold|errorCreates a hold in the specified matter.
Parameters
- matterId string - The matter ID.
- payload Hold - Hold to be created
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
getHold
Isolated FunctionRemote Function
function getHold(string matterId, string holdId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? view) returns Hold|errorGets the specified hold.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- view string? (default ()) - The amount of detail to return for a hold.
updateHold
Isolated FunctionRemote Function
function updateHold(string matterId, string holdId, Hold payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Hold|errorUpdates 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.
Parameters
- matterId string - The matter ID.
- holdId string - The ID of the hold.
- payload Hold - Hold to be updated
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
deleteHold
Isolated FunctionRemote Function
function deleteHold(string matterId, string holdId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorRemoves the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
listAccounts
Isolated FunctionRemote Function
function listAccounts(string matterId, string holdId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns ListHeldAccountsResponse|errorLists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the Admin SDK. to list the members of the organizational unit on hold.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- ListHeldAccountsResponse|error - Successful response
createAccount
Isolated FunctionRemote Function
function createAccount(string matterId, string holdId, HeldAccount payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns HeldAccount|errorAdds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- payload HeldAccount - Account to be created
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- HeldAccount|error - Successful response
deleteAccount
Isolated FunctionRemote Function
function deleteAccount(string matterId, string holdId, string accountId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorRemoves an account from a hold.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- accountId string - The ID of the account to remove from the hold.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
addHeldAccount
Isolated FunctionRemote Function
function addHeldAccount(string matterId, string holdId, AddHeldAccountsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns AddHeldAccountsResponse|errorAdds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- payload AddHeldAccountsRequest - Account to be created
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- AddHeldAccountsResponse|error - Successful response
removeHeldAccount
Isolated FunctionRemote Function
function removeHeldAccount(string matterId, string holdId, RemoveHeldAccountsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns RemoveHeldAccountsResponse|errorRemoves the specified accounts from a hold. Returns a list of statuses in the same order as the request.
Parameters
- matterId string - The matter ID.
- holdId string - The hold ID.
- payload RemoveHeldAccountsRequest - Account to be removed
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- RemoveHeldAccountsResponse|error - Successful response
listSavedQueries
Isolated FunctionRemote Function
function listSavedQueries(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListSavedQueriesResponse|errorLists the saved queries in a matter.
Parameters
- matterId string - The ID of the matter to get the saved queries for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - The maximum number of saved queries to return.
- pageToken string? (default ()) - The pagination token as returned in the previous response. An empty token means start from the beginning.
Return Type
- ListSavedQueriesResponse|error - Successful response
createSavedQueries
Isolated FunctionRemote Function
function createSavedQueries(string matterId, SavedQuery payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns SavedQuery|errorCreates a saved query.
Parameters
- matterId string - The ID of the matter to create the saved query in.
- payload SavedQuery - Query
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- SavedQuery|error - Successful response
getSavedQueries
Isolated FunctionRemote Function
function getSavedQueries(string matterId, string savedQueryId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns SavedQuery|errorRetrieves the specified saved query.
Parameters
- matterId string - The ID of the matter to get the saved query from.
- savedQueryId string - ID of the saved query to retrieve.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- SavedQuery|error - Successful response
deleteSavedQueries
Isolated FunctionRemote Function
function deleteSavedQueries(string matterId, string savedQueryId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorDeletes the specified saved query.
Parameters
- matterId string - The ID of the matter to delete the saved query from.
- savedQueryId string - ID of the saved query to delete.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
addVaultPermission
Isolated FunctionRemote Function
function addVaultPermission(string matterId, AddMatterPermissionsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns MatterPermission|errorAdds an account as a matter collaborator.
Parameters
- matterId string - The matter ID.
- payload AddMatterPermissionsRequest - Account to be added
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- MatterPermission|error - Successful response
closeMatter
Isolated FunctionRemote Function
function closeMatter(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CloseMatterResponse|errorCloses the specified matter. Returns the matter with updated state.
Parameters
- matterId string - The matter ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- CloseMatterResponse|error - Successful response
countMatters
Isolated FunctionRemote Function
function countMatters(string matterId, CountArtifactsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Operation|errorCounts the accounts processed by the specified query.
Parameters
- matterId string - The matter ID.
- payload CountArtifactsRequest - Accounts to be counted
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
removeMatterPermission
Isolated FunctionRemote Function
function removeMatterPermission(string matterId, RemoveMatterPermissionsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorRemoves an account as a matter collaborator.
Parameters
- matterId string - The matter ID.
- payload RemoveMatterPermissionsRequest - Account to be removed
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
reopenMatter
Isolated FunctionRemote Function
function reopenMatter(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns ReopenMatterResponse|errorReopens the specified matter. Returns the matter with updated state.
Parameters
- matterId string - The matter ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- ReopenMatterResponse|error - Successful response
undeleteMatter
Isolated FunctionRemote Function
function undeleteMatter(string matterId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Matter|errorUndeletes the specified matter. Returns the matter with updated state.
Parameters
- matterId string - The matter ID.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
listVaultOperations
Isolated FunctionRemote Function
function listVaultOperations(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, int? pageSize, string? pageToken) returns ListOperationsResponse|errorLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters
- name string - The name of the operation's parent resource.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- filter string? (default ()) - The standard list filter.
- pageSize int? (default ()) - The standard list page size.
- pageToken string? (default ()) - The standard list page token.
Return Type
- ListOperationsResponse|error - Successful response
deleteVaultOperation
Isolated FunctionRemote Function
function deleteVaultOperation(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Parameters
- name string - The name of the operation resource to be deleted.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
cancelVaultOperation
Isolated FunctionRemote Function
function cancelVaultOperation(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|errorStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Parameters
- name string - The name of the operation resource to be cancelled.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Records
googleapis.vault: AccountCount
The results count for each account.
Fields
- account? UserInfo - User's information.
- count? string - The number of results (messages or files) found for this account.
googleapis.vault: AccountCountError
An error that occurred when querying a specific account
Fields
- account? UserInfo - User's information.
- errorType? string - Account query error.
googleapis.vault: AccountInfo
The accounts to search
Fields
- emails? string[] - A set of accounts to search.
googleapis.vault: AddHeldAccountResult
The status of each account creation, and the HeldAccount, if successful.
Fields
- account? HeldAccount - An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) 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.
- status? Status - The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatusmessage contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
googleapis.vault: AddHeldAccountsRequest
Add a list of accounts to a hold.
Fields
- accountIds? string[] - A comma-separated list of the account IDs of the accounts to add to the hold. Specify either emails or account_ids, but not both.
- emails? string[] - A comma-separated list of the emails of the accounts to add to the hold. Specify either emails or account_ids, but not both.
googleapis.vault: AddHeldAccountsResponse
Response for batch create held accounts.
Fields
- responses? AddHeldAccountResult[] - The list of responses, in the same order as the batch request.
googleapis.vault: AddMatterPermissionsRequest
Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.
Fields
- ccMe? boolean - Only relevant if sendEmails is true. To CC the requestor in the email message, set to true. To not CC requestor, set to false.
- matterPermission? MatterPermission - Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- sendEmails? boolean - To send a notification email to the added account, set to true. To not send a notification email, set to false.
googleapis.vault: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
googleapis.vault: CloseMatterResponse
Response to a CloseMatterRequest.
Fields
- matter? Matter - Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) 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.
googleapis.vault: CloudStorageFile
The export file in Cloud Storage
Fields
- bucketName? string - The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage JSON or XML APIs, but not to list the bucket contents. Instead, you can get individual export files by object name.
- md5Hash? string - The md5 hash of the file.
- objectName? string - The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage JSON or XML APIs.
- size? string - The export file size.
googleapis.vault: CloudStorageSink
Export sink for Cloud Storage files.
Fields
- files? CloudStorageFile[] - Output only. The exported files in Cloud Storage.
googleapis.vault: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
googleapis.vault: CorpusQuery
Service-specific options for holds.
Fields
- driveQuery? HeldDriveQuery - Options for Drive holds.
- groupsQuery? HeldGroupsQuery - Query options for group holds.
- hangoutsChatQuery? HeldHangoutsChatQuery - Options for Chat holds.
- mailQuery? HeldMailQuery - Query options for Gmail holds.
- voiceQuery? HeldVoiceQuery - Options for Voice holds.
googleapis.vault: CountArtifactsMetadata
Long running operation metadata for CountArtifacts.
Fields
- endTime? string - End time of count operation. Available when operation is done.
- matterId? string - The matter ID of the associated matter.
- query? Query - The query definition used for search and export.
- startTime? string - Creation time of count operation.
googleapis.vault: CountArtifactsRequest
Count artifacts request.
Fields
- query? Query - The query definition used for search and export.
- view? string - Sets the granularity of the count results.
googleapis.vault: CountArtifactsResponse
Definition of the response for method CountArtifacts.
Fields
- groupsCountResult? GroupsCountResult - Groups specific count metrics.
- mailCountResult? MailCountResult - Gmail and classic Hangouts-specific count metrics.
- totalCount? string - Total count of messages.
googleapis.vault: DriveExportOptions
Options for Drive exports.
Fields
- includeAccessInfo? boolean - To include access level information for users with indirect access to files, set to true.
googleapis.vault: DriveOptions
Additional options for Drive search
Fields
- includeTeamDrives? boolean - Set to true to include Team Drive.
- versionDate? string - Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
googleapis.vault: Export
An export. 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.
Fields
- cloudStorageSink? CloudStorageSink - Export sink for Cloud Storage files.
- createTime? string - Output only. The time when the export was created.
- exportOptions? ExportOptions - Additional options for exports
- id? string - Output only. The generated export ID.
- matterId? string - Output only. The matter ID.
- name? string - The export name.
- query? Query - The query definition used for search and export.
- requester? UserInfo - User's information.
- stats? ExportStats - Progress information for an export.
- status? string - Output only. The status of the export.
googleapis.vault: ExportOptions
Additional options for exports
Fields
- driveOptions? DriveExportOptions - Options for Drive exports.
- groupsOptions? GroupsExportOptions - Options for Groups exports.
- hangoutsChatOptions? HangoutsChatExportOptions - Options for Chat exports.
- mailOptions? MailExportOptions - Options for Gmail exports.
- region? string - The requested data region for the export.
- voiceOptions? VoiceExportOptions - The options for Voice exports.
googleapis.vault: ExportStats
Progress information for an export.
Fields
- exportedArtifactCount? string - The number of messages or files already processed for export.
- sizeInBytes? string - The size of export in bytes.
- totalArtifactCount? string - The number of messages or files to be exported.
googleapis.vault: GroupsCountResult
Groups specific count metrics.
Fields
- accountCountErrors? AccountCountError[] - Error occurred when querying these accounts.
- accountCounts? AccountCount[] - Subtotal count per matching account that have more than zero messages.
- matchingAccountsCount? string - Total number of accounts that can be queried and have more than zero messages.
- nonQueryableAccounts? string[] - When DataScope is HELD_DATA, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.
- queriedAccountsCount? string - Total number of accounts involved in this count operation.
googleapis.vault: GroupsExportOptions
Options for Groups exports.
Fields
- exportFormat? string - The file format for exported messages.
googleapis.vault: HangoutsChatExportOptions
Options for Chat exports.
Fields
- exportFormat? string - The file format for exported messages.
googleapis.vault: HangoutsChatInfo
The Chat spaces to search
Fields
googleapis.vault: HangoutsChatOptions
Additional options for Google Chat search
Fields
- includeRooms? boolean - For searches by account or organizational unit, set to true to include rooms.
googleapis.vault: HeldAccount
An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) 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.
Fields
- email? string - The primary email address of the account. If used as an input, this takes precedence over accountId.
- firstName? string - Output only. The first name of the account holder.
- holdTime? string - Output only. When the account was put on hold.
- lastName? string - Output only. The last name of the account holder.
googleapis.vault: HeldDriveQuery
Options for Drive holds.
Fields
- includeTeamDriveFiles? boolean - To include files in Team Drives in the hold, set to true.
googleapis.vault: HeldGroupsQuery
Query options for group holds.
Fields
- endTime? string - The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
- startTime? string - The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
- terms? string - The search operators used to refine the messages covered by the hold.
googleapis.vault: HeldHangoutsChatQuery
Options for Chat holds.
Fields
- includeRooms? boolean - To include messages in Chat spaces the user was a member of, set to true.
googleapis.vault: HeldMailQuery
Query options for Gmail holds.
Fields
- endTime? string - The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
- startTime? string - The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
- terms? string - The search operators used to refine the messages covered by the hold.
googleapis.vault: HeldOrgUnit
The organizational unit covered by a hold. This structure is immutable.
Fields
- holdTime? string - When the organizational unit was put on hold. This property is immutable.
googleapis.vault: HeldVoiceQuery
Options for Voice holds.
Fields
- coveredData? string[] - A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
googleapis.vault: Hold
A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) 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.
Fields
- accounts? HeldAccount[] - If set, the hold applies to the specified accounts and orgUnit must be empty.
- corpus? string - The service to be searched.
- holdId? string - The unique immutable ID of the hold. Assigned during creation.
- name? string - The name of the hold.
- orgUnit? HeldOrgUnit - The organizational unit covered by a hold. This structure is immutable.
- query? CorpusQuery - Service-specific options for holds.
- updateTime? string - The last time this hold was modified.
googleapis.vault: ListExportsResponse
The exports for a matter.
Fields
- exports? Export[] - The list of exports.
- nextPageToken? string - Page token to retrieve the next page of results in the list.
googleapis.vault: ListHeldAccountsResponse
Returns a list of the accounts covered by a hold.
Fields
- accounts? HeldAccount[] - The held accounts on a hold.
googleapis.vault: ListHoldsResponse
The holds for a matter.
Fields
- holds? Hold[] - The list of holds.
- nextPageToken? string - Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
googleapis.vault: ListMattersResponse
Provides the list of matters.
Fields
- matters? Matter[] - List of matters.
- nextPageToken? string - Page token to retrieve the next page of results in the list.
googleapis.vault: ListOperationsResponse
The response message for Operations.ListOperations.
Fields
- nextPageToken? string - The standard List next-page token.
- operations? Operation[] - A list of operations that matches the specified filter in the request.
googleapis.vault: ListSavedQueriesResponse
Definition of the response for method ListSaveQuery.
Fields
- nextPageToken? string - 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.
- savedQueries? SavedQuery[] - List of saved queries.
googleapis.vault: MailCountResult
Gmail and classic Hangouts-specific count metrics.
Fields
- accountCountErrors? AccountCountError[] - Errors occurred when querying these accounts.
- accountCounts? AccountCount[] - Subtotal count per matching account that have more than zero messages.
- matchingAccountsCount? string - Total number of accounts that can be queried and have more than zero messages.
- nonQueryableAccounts? string[] - When DataScope is HELD_DATA, the number of accounts in the request that are not queried because they are not on hold. For other data scopes, this field is not set.
- queriedAccountsCount? string - Total number of accounts involved in this count operation.
googleapis.vault: MailExportOptions
Options for Gmail exports.
Fields
- exportFormat? string - The file format for exported messages.
- showConfidentialModeContent? boolean - To export confidential mode content, set to true.
googleapis.vault: MailOptions
Additional options for Gmail search
Fields
- excludeDrafts? boolean - Set to true to exclude drafts.
googleapis.vault: Matter
Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) 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.
Fields
- description? string - An optional description for the matter.
- matterId? string - The matter ID, which is generated by the server. Leave blank when creating a matter.
- matterPermissions? MatterPermission[] - Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- name? string - The name of the matter.
- state? string - The state of the matter.
googleapis.vault: MatterPermission
Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
Fields
- role? string - The user's role for the matter.
googleapis.vault: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL
googleapis.vault: Operation
This resource represents a long-running operation that is the result of a network API call.
Fields
- done? boolean - If the value is
false, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
- 'error? Status - The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatusmessage contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
- metadata? record {} - Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- name? string - The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the
nameshould be a resource name ending withoperations/{unique_id}.
- response? record {} - The normal response of the operation in case of success. If the original method returns no data on success, such as
Delete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, whereXxxis the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type isTakeSnapshotResponse.
googleapis.vault: OrgUnitInfo
The organizational unit to search
Fields
- orgUnitId? string - The name of the organizational unit to search, as provided by the Admin SDK Directory API.
googleapis.vault: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
googleapis.vault: Query
The query definition used for search and export.
Fields
- accountInfo? AccountInfo - The accounts to search
- corpus? string - The Google Workspace service to search.
- dataScope? string - The data source to search.
- driveOptions? DriveOptions - Additional options for Drive search
- endTime? string - The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
- hangoutsChatInfo? HangoutsChatInfo - The Chat spaces to search
- hangoutsChatOptions? HangoutsChatOptions - Additional options for Google Chat search
- mailOptions? MailOptions - Additional options for Gmail search
- method? string - The entity to search. This field replaces searchMethod to support shared drives. When searchMethod is TEAM_DRIVE, the response of this field is SHARED_DRIVE.
- orgUnitInfo? OrgUnitInfo - The organizational unit to search
- searchMethod? string - The search method to use.
- startTime? string - The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
- teamDriveInfo? TeamDriveInfo - Team Drives to search
- terms? string - Service-specific search operators to filter search results.
- timeZone? string - The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see Time Zone. For more information about how Vault uses time zones, see the Vault help center.
- voiceOptions? VoiceOptions - Additional options for Voice search
googleapis.vault: RemoveHeldAccountsRequest
Remove a list of accounts from a hold.
Fields
- accountIds? string[] - The account IDs of the accounts to remove from the hold.
googleapis.vault: RemoveHeldAccountsResponse
Response for batch delete held accounts.
Fields
- statuses? Status[] - A list of statuses for the deleted accounts. Results have the same order as the request.
googleapis.vault: RemoveMatterPermissionsRequest
Remove an account as a matter collaborator.
Fields
- accountId? string - The account ID.
googleapis.vault: ReopenMatterResponse
Response to a ReopenMatterRequest.
Fields
- matter? Matter - Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) 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.
googleapis.vault: SavedQuery
The definition of a saved query. 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.
Fields
- createTime? string - Output only. The server-generated timestamp when the saved query was created.
- displayName? string - The name of the saved query.
- matterId? string - Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
- query? Query - The query definition used for search and export.
- savedQueryId? string - A unique identifier for the saved query.
googleapis.vault: SharedDriveInfo
The shared drives to search
Fields
googleapis.vault: 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. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Fields
- code? int - The status code, which should be an enum value of google.rpc.Code.
- details? record {}[] - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message? string - 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.
googleapis.vault: TeamDriveInfo
Team Drives to search
Fields
googleapis.vault: UserInfo
User's information.
Fields
- displayName? string - The displayed name of the user.
- email? string - The email address of the user.
googleapis.vault: VoiceExportOptions
The options for Voice exports.
Fields
- exportFormat? string - The file format for exported text messages.
googleapis.vault: VoiceOptions
Additional options for Voice search
Fields
- coveredData? string[] - Datatypes to search