Module google_vault1::api

source ·

Structs§

  • The accounts to search
  • The status of each account creation, and the HeldAccount, if successful.
  • Add a list of accounts to a hold.
  • Response for batch create held accounts.
  • 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.
  • The options for Calendar exports.
  • Additional options for Calendar search
  • The request message for Operations.CancelOperation.
  • Close a matter by ID.
  • Response to a CloseMatterRequest.
  • The export file in Cloud Storage
  • Export sink for Cloud Storage files.
  • Service-specific options for holds.
  • Count artifacts request.
  • Options for Drive exports.
  • Additional options for Drive search
  • 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); }
  • 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.
  • Additional options for exports
  • Progress information for an export.
  • Options for Groups exports.
  • Options for Chat exports.
  • The Chat spaces to search
  • Additional options for Google Chat search
  • 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.
  • Options for Drive holds.
  • Query options for group holds.
  • Options for Chat holds.
  • Query options for Gmail holds.
  • The organizational unit covered by a hold. This structure is immutable.
  • Options for Voice holds.
  • 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.
  • The exports for a matter.
  • Returns a list of the accounts covered by a hold.
  • The holds for a matter.
  • Provides the list of matters.
  • The response message for Operations.ListOperations.
  • Definition of the response for method ListSaveQuery.
  • Options for Gmail exports.
  • Additional options for Gmail search
  • 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.
  • Adds an account as a matter collaborator.
  • Closes the specified matter. Returns the matter with updated state.
  • Counts the accounts processed by the specified query.
  • Creates 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.
  • Deletes the specified matter. Returns the matter with updated state.
  • Creates an export.
  • Deletes an export.
  • Gets an export.
  • Lists details about the exports in the specified matter.
  • Gets the specified matter.
  • Adds 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.
  • Removes an account from a hold.
  • Lists 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.
  • Adds 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.
  • Creates a hold in the specified matter.
  • Removes 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.
  • Gets the specified hold.
  • Lists the holds in a matter.
  • Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
  • Updates 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.
  • Lists matters the requestor has access to.
  • A builder providing access to all methods supported on matter resources. It is not used directly, but through the Vault hub.
  • 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.
  • Removes an account as a matter collaborator.
  • Reopens the specified matter. Returns the matter with updated state.
  • Creates a saved query.
  • Deletes the specified saved query.
  • Retrieves the specified saved query.
  • Lists the saved queries in a matter.
  • Undeletes the specified matter. Returns the matter with updated state.
  • Updates 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.
  • This resource represents a long-running operation that is the result of a network API call.
  • Starts 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.
  • Deletes 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.
  • Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
  • A builder providing access to all methods supported on operation resources. It is not used directly, but through the Vault hub.
  • The organizational unit to search
  • The query definition used for search and export.
  • Remove a list of accounts from a hold.
  • Response for batch delete held accounts.
  • Remove an account as a matter collaborator.
  • Reopen a matter by ID.
  • Response to a ReopenMatterRequest.
  • 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.
  • The shared drives to search
  • The published site URLs of new Google Sites to search
  • 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.
  • Team Drives to search
  • Undelete a matter by ID.
  • User’s information.
  • Central instance to access all Vault related resource activities
  • The options for Voice exports.
  • Additional options for Voice search

Enums§