{ "description": "Retention and eDiscovery for Google Workspace. 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. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ", "batchPath": "batch", "kind": "discovery#restDescription", "discoveryVersion": "v1", "version": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "Operation": { "properties": { "metadata": { "type": "object", "description": "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.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." } }, "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation" }, "AccountInfo": { "id": "AccountInfo", "description": "The accounts to search", "type": "object", "properties": { "emails": { "description": "A set of accounts to search.", "type": "array", "items": { "type": "string" } } } }, "CalendarOptions": { "description": "Additional options for Calendar search", "properties": { "locationQuery": { "description": "Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in \"and\". Word splitting example: [\"New Zealand\"] vs [\"New\",\"Zealand\"] \"New Zealand\": matched by both \"New and better Zealand\": only matched by the later", "items": { "type": "string" }, "type": "array" }, "minusWords": { "description": "Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in \"or\".", "items": { "type": "string" }, "type": "array" }, "responseStatuses": { "description": "Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.", "type": "array", "items": { "enum": [ "ATTENDEE_RESPONSE_UNSPECIFIED", "ATTENDEE_RESPONSE_NEEDS_ACTION", "ATTENDEE_RESPONSE_ACCEPTED", "ATTENDEE_RESPONSE_DECLINED", "ATTENDEE_RESPONSE_TENTATIVE" ], "type": "string", "enumDescriptions": [ "Attendee response unspecified. If this is set no filtering on responses will be done, all other attendee responses that are part of the query options are ignored.", "The participant has been invited but has not responded yet.", "The participant plans to attend.", "The participant does not plan to attend.", "The participant expects to possibly attend." ] } }, "peopleQuery": { "items": { "type": "string" }, "description": "Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in \"and\".", "type": "array" }, "versionDate": { "format": "google-datetime", "type": "string", "description": "Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC." } }, "type": "object", "id": "CalendarOptions" }, "CloudStorageSink": { "properties": { "files": { "items": { "$ref": "CloudStorageFile" }, "description": "Output only. The exported files in Cloud Storage.", "type": "array" } }, "type": "object", "description": "Export sink for Cloud Storage files.", "id": "CloudStorageSink" }, "HeldVoiceQuery": { "description": "Options for Voice holds.", "type": "object", "id": "HeldVoiceQuery", "properties": { "coveredData": { "type": "array", "description": "A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.", "items": { "type": "string", "enumDescriptions": [ "Covered data unspecified.", "Voice text messages.", "Voicemails and their transcripts.", "Call logs." ], "enum": [ "COVERED_DATA_UNSPECIFIED", "TEXT_MESSAGES", "VOICEMAILS", "CALL_LOGS" ] } } } }, "CancelOperationRequest": { "id": "CancelOperationRequest", "properties": {}, "type": "object", "description": "The request message for Operations.CancelOperation." }, "VoiceOptions": { "type": "object", "properties": { "coveredData": { "type": "array", "description": "Datatypes to search", "items": { "enum": [ "COVERED_DATA_UNSPECIFIED", "TEXT_MESSAGES", "VOICEMAILS", "CALL_LOGS" ], "type": "string", "enumDescriptions": [ "Covered data unspecified.", "Voice text messages.", "Voicemails and their transcripts.", "Call logs." ] } } }, "description": "Additional options for Voice search", "id": "VoiceOptions" }, "Export": { "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time when the export was created." }, "query": { "description": "The query parameters used to create the export.", "$ref": "Query" }, "matterId": { "type": "string", "description": "Output only. The matter ID." }, "exportOptions": { "$ref": "ExportOptions", "description": "Additional export options." }, "parentExportId": { "type": "string", "description": "Output only. Identifies the parent export that spawned this child export. This is only set on child exports.", "readOnly": true }, "stats": { "description": "Output only. Details about the export progress and size.", "$ref": "ExportStats" }, "cloudStorageSink": { "description": "Output only. The sink for export files in Cloud Storage.", "$ref": "CloudStorageSink" }, "requester": { "$ref": "UserInfo", "description": "Output only. The requester of the export." }, "name": { "type": "string", "description": "The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports." }, "status": { "enumDescriptions": [ "The status is unspecified.", "The export completed.", "The export failed.", "The export is in progress." ], "enum": [ "EXPORT_STATUS_UNSPECIFIED", "COMPLETED", "FAILED", "IN_PROGRESS" ], "description": "Output only. The status of the export.", "type": "string" }, "id": { "type": "string", "description": "Output only. The generated export ID." } }, "description": "An export. 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.", "type": "object", "id": "Export" }, "ListHeldAccountsResponse": { "properties": { "accounts": { "description": "The held accounts on a hold.", "items": { "$ref": "HeldAccount" }, "type": "array" } }, "id": "ListHeldAccountsResponse", "type": "object", "description": "Returns a list of the accounts covered by a hold." }, "RemoveHeldAccountsResponse": { "properties": { "statuses": { "description": "A list of statuses for the deleted accounts. Results have the same order as the request.", "items": { "$ref": "Status" }, "type": "array" } }, "id": "RemoveHeldAccountsResponse", "description": "Response for batch delete held accounts.", "type": "object" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations." }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object", "id": "ListOperationsResponse" }, "AccountCountError": { "properties": { "account": { "description": "Account owner.", "$ref": "UserInfo" }, "errorType": { "enum": [ "ERROR_TYPE_UNSPECIFIED", "WILDCARD_TOO_BROAD", "TOO_MANY_TERMS", "LOCATION_UNAVAILABLE", "UNKNOWN", "DEADLINE_EXCEEDED" ], "enumDescriptions": [ "Default.", "Permanent - prefix terms expanded to too many query terms.", "Permanent - query contains too many terms.", "Transient - data in transit between storage replicas, temporarily unavailable.", "Unrecognized error.", "Deadline exceeded when querying the account." ], "description": "Account query error.", "type": "string" } }, "description": "An error that occurred when querying a specific account", "id": "AccountCountError", "type": "object" }, "HeldGroupsQuery": { "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date." }, "terms": { "type": "string", "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold." }, "startTime": { "format": "google-datetime", "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "type": "string" } }, "id": "HeldGroupsQuery", "type": "object", "description": "Query options for group holds." }, "Matter": { "id": "Matter", "type": "object", "description": "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.", "properties": { "matterPermissions": { "description": "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.", "type": "array", "items": { "$ref": "MatterPermission" } }, "matterRegion": { "enum": [ "MATTER_REGION_UNSPECIFIED", "ANY", "US", "EUROPE" ], "enumDescriptions": [ "The region is unspecified. Defaults to ANY.", "Any region.", "United States region.", "Europe region." ], "description": "Optional. The requested data region for the matter.", "type": "string" }, "name": { "type": "string", "description": "The name of the matter." }, "state": { "description": "The state of the matter.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "OPEN", "CLOSED", "DELETED" ], "enumDescriptions": [ "The matter has no specified state.", "The matter is open.", "The matter is closed.", "The matter is deleted." ] }, "description": { "description": "An optional description for the matter.", "type": "string" }, "matterId": { "description": "The matter ID, which is generated by the server. Leave blank when creating a matter.", "type": "string" } } }, "CountArtifactsResponse": { "id": "CountArtifactsResponse", "properties": { "totalCount": { "description": "Total count of messages.", "format": "int64", "type": "string" }, "groupsCountResult": { "description": "Count metrics for Groups.", "$ref": "GroupsCountResult" }, "mailCountResult": { "$ref": "MailCountResult", "description": "Count metrics for Gmail and classic Hangouts." } }, "type": "object", "description": "Definition of the response for method CountArtifacts." }, "Empty": { "properties": {}, "type": "object", "description": "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); }", "id": "Empty" }, "HangoutsChatInfo": { "id": "HangoutsChatInfo", "type": "object", "properties": { "roomId": { "items": { "type": "string" }, "description": "A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.", "type": "array" } }, "description": "The Chat spaces to search" }, "AddMatterPermissionsRequest": { "id": "AddMatterPermissionsRequest", "description": "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.", "type": "object", "properties": { "sendEmails": { "type": "boolean", "description": "To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**." }, "ccMe": { "type": "boolean", "description": "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": { "$ref": "MatterPermission", "description": "The account and its role to add." } } }, "UndeleteMatterRequest": { "properties": {}, "id": "UndeleteMatterRequest", "description": "Undelete a matter by ID.", "type": "object" }, "HeldDriveQuery": { "type": "object", "properties": { "includeTeamDriveFiles": { "description": "To include files in Team Drives in the hold, set to **true**.", "type": "boolean", "deprecated": true }, "includeSharedDriveFiles": { "description": "To include files in shared drives in the hold, set to **true**.", "type": "boolean" } }, "id": "HeldDriveQuery", "description": "Options for Drive holds." }, "VoiceExportOptions": { "type": "object", "id": "VoiceExportOptions", "description": "The options for Voice exports.", "properties": { "exportFormat": { "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "description": "The file format for exported text messages.", "type": "string" } } }, "HangoutsChatOptions": { "properties": { "includeRooms": { "description": "For searches by account or organizational unit, set to **true** to include rooms.", "type": "boolean" } }, "description": "Additional options for Google Chat search", "id": "HangoutsChatOptions", "type": "object" }, "HeldOrgUnit": { "properties": { "orgUnitId": { "type": "string", "description": "The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/)." }, "holdTime": { "type": "string", "format": "google-datetime", "description": "When the organizational unit was put on hold. This property is immutable." } }, "type": "object", "id": "HeldOrgUnit", "description": "The organizational unit covered by a hold. This structure is immutable." }, "DriveOptions": { "properties": { "includeSharedDrives": { "description": "Set to **true** to include shared drives.", "deprecated": true, "type": "boolean" }, "includeTeamDrives": { "type": "boolean", "deprecated": true, "description": "Set to true to include Team Drive." }, "sharedDrivesOption": { "type": "string", "enumDescriptions": [ "No shared drive option specified.", "If a resource is in a shared drive, it isn't included in the search.", "Shared drive resources are only included in instances where the account is a collaborator on a resource but they are not a member of the shared drive. This maps to the *\"Included only if documents shared directly (not due to shared drive membership)\"* option in the Vault UI. (Previously \"include_shared_drives\" off)", "Resources in shared drives are included in the search. (Previously \"include_shared_drives\" on)" ], "description": "Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.", "enum": [ "SHARED_DRIVES_OPTION_UNSPECIFIED", "NOT_INCLUDED", "INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER", "INCLUDED" ] }, "versionDate": { "format": "google-datetime", "type": "string", "description": "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." }, "clientSideEncryptedOption": { "description": "Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.", "enum": [ "CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED", "CLIENT_SIDE_ENCRYPTED_OPTION_ANY", "CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED", "CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED" ], "type": "string", "enumDescriptions": [ "Encryption status unspecified. Results include both client-side encrypted and non-encrypted content.", "Include both client-side encrypted and unencrypted content in results.", "Include client-side encrypted content only.", "Include unencrypted content only." ] } }, "description": "Additional options for Drive search.", "id": "DriveOptions", "type": "object" }, "ReopenMatterRequest": { "id": "ReopenMatterRequest", "description": "Reopen a matter by ID.", "properties": {}, "type": "object" }, "ListMattersResponse": { "properties": { "nextPageToken": { "description": "Page token to retrieve the next page of results in the list.", "type": "string" }, "matters": { "items": { "$ref": "Matter" }, "description": "List of matters.", "type": "array" } }, "description": "Provides the list of matters.", "type": "object", "id": "ListMattersResponse" }, "HeldHangoutsChatQuery": { "id": "HeldHangoutsChatQuery", "description": "Options for Chat holds.", "type": "object", "properties": { "includeRooms": { "description": "To include messages in Chat spaces the user was a member of, set to **true**.", "type": "boolean" } } }, "RemoveHeldAccountsRequest": { "type": "object", "id": "RemoveHeldAccountsRequest", "description": "Remove a list of accounts from a hold.", "properties": { "accountIds": { "description": "The account IDs of the accounts to remove from the hold.", "items": { "type": "string" }, "type": "array" } } }, "DriveDocumentInfo": { "description": "The Drive documents to search.", "id": "DriveDocumentInfo", "type": "object", "properties": { "documentIds": { "description": "Specify Drive documents by document ID.", "$ref": "DriveDocumentIds" } } }, "Query": { "properties": { "driveOptions": { "$ref": "DriveOptions", "description": "Set Drive search-specific options." }, "terms": { "description": "Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.", "type": "string" }, "voiceOptions": { "description": "Set Voice search-specific options.", "$ref": "VoiceOptions" }, "sharedDriveInfo": { "$ref": "SharedDriveInfo", "description": "Required when **SearchMethod** is **SHARED_DRIVE**." }, "hangoutsChatOptions": { "description": "Set Chat search-specific options. (read-only)", "$ref": "HangoutsChatOptions" }, "dataScope": { "type": "string", "description": "The data source to search.", "enumDescriptions": [ "No data source specified.", "All available data.", "Only data on hold.", "Only data not yet processed by Vault. (Gmail and Groups only)" ], "enum": [ "DATA_SCOPE_UNSPECIFIED", "ALL_DATA", "HELD_DATA", "UNPROCESSED_DATA" ] }, "accountInfo": { "$ref": "AccountInfo", "description": "Required when **SearchMethod** is **ACCOUNT**." }, "orgUnitInfo": { "description": "Required when **SearchMethod** is **ORG_UNIT**.", "$ref": "OrgUnitInfo" }, "calendarOptions": { "description": "Set Calendar search-specific options.", "$ref": "CalendarOptions" }, "startTime": { "type": "string", "description": "The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "format": "google-datetime" }, "mailOptions": { "description": "Set Gmail search-specific options.", "$ref": "MailOptions" }, "timeZone": { "type": "string", "description": "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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time)." }, "sitesUrlInfo": { "$ref": "SitesUrlInfo", "description": "Required when **SearchMethod** is **SITES_URL**." }, "driveDocumentInfo": { "$ref": "DriveDocumentInfo", "description": "Required when **SearchMethod** is **DRIVE_DOCUMENT**." }, "searchMethod": { "deprecated": true, "description": "The search method to use.", "enumDeprecated": [ false, false, false, true, false, false, false, false, false ], "enumDescriptions": [ "A search method must be specified or else it is rejected.", "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#accountinfo).", "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#orgunitinfo).", "Search the data in the Team Drive specified in **team_drive_info**.", "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#sitesurlinfo).", "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#shareddriveinfo).", "Retrieve the documents specified in DriveDocumentInfo." ], "enum": [ "SEARCH_METHOD_UNSPECIFIED", "ACCOUNT", "ORG_UNIT", "TEAM_DRIVE", "ENTIRE_ORG", "ROOM", "SITES_URL", "SHARED_DRIVE", "DRIVE_DOCUMENT" ], "type": "string" }, "method": { "description": "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**.", "type": "string", "enum": [ "SEARCH_METHOD_UNSPECIFIED", "ACCOUNT", "ORG_UNIT", "TEAM_DRIVE", "ENTIRE_ORG", "ROOM", "SITES_URL", "SHARED_DRIVE", "DRIVE_DOCUMENT" ], "enumDescriptions": [ "A search method must be specified or else it is rejected.", "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#accountinfo).", "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#orgunitinfo).", "Search the data in the Team Drive specified in **team_drive_info**.", "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#sitesurlinfo).", "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#shareddriveinfo).", "Retrieve the documents specified in DriveDocumentInfo." ], "enumDeprecated": [ false, false, false, true, false, false, false, false, false ] }, "geminiOptions": { "description": "Set Gemini search-specific options.", "$ref": "GeminiOptions" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date." }, "teamDriveInfo": { "$ref": "TeamDriveInfo", "deprecated": true, "description": "Required when **SearchMethod** is **TEAM_DRIVE**." }, "hangoutsChatInfo": { "description": "Required when **SearchMethod** is **ROOM**. (read-only)", "$ref": "HangoutsChatInfo" }, "corpus": { "enum": [ "CORPUS_TYPE_UNSPECIFIED", "DRIVE", "MAIL", "GROUPS", "HANGOUTS_CHAT", "VOICE", "CALENDAR", "GEMINI" ], "enumDescriptions": [ "No service specified.", "Drive, including Meet and Sites.", "For search, Gmail and classic Hangouts. For holds, Gmail only.", "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", "Calendar.", "Gemini." ], "description": "The Google Workspace service to search.", "type": "string" } }, "type": "object", "description": "The query definition used for search and export.", "id": "Query" }, "ListHoldsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.", "type": "string" }, "holds": { "items": { "$ref": "Hold" }, "type": "array", "description": "The list of holds." } }, "description": "The holds for a matter.", "id": "ListHoldsResponse" }, "CloseMatterResponse": { "description": "Response to a CloseMatterRequest.", "type": "object", "id": "CloseMatterResponse", "properties": { "matter": { "$ref": "Matter", "description": "The updated matter, with state **CLOSED**." } } }, "DriveExportOptions": { "description": "Options for Drive exports.", "id": "DriveExportOptions", "properties": { "includeAccessInfo": { "description": "To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.", "type": "boolean" } }, "type": "object" }, "SharedDriveInfo": { "description": "The shared drives to search", "type": "object", "properties": { "sharedDriveIds": { "items": { "type": "string" }, "description": "A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).", "type": "array" } }, "id": "SharedDriveInfo" }, "MailExportOptions": { "type": "object", "properties": { "exportLinkedDriveFiles": { "type": "boolean", "description": "Optional. To enable exporting linked Drive files, set to **true**." }, "showConfidentialModeContent": { "description": "To export confidential mode content, set to **true**.", "type": "boolean" }, "exportFormat": { "type": "string", "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "description": "The file format for exported messages.", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ] }, "useNewExport": { "description": "To use the new export system, set to **true**.", "type": "boolean" } }, "description": "Options for Gmail exports.", "id": "MailExportOptions" }, "AddHeldAccountResult": { "description": "The status of each account creation, and the **HeldAccount**, if successful.", "type": "object", "properties": { "account": { "$ref": "HeldAccount", "description": "Returned when the account was successfully created." }, "status": { "description": "Reports the request status. If it failed, returns an error message.", "$ref": "Status" } }, "id": "AddHeldAccountResult" }, "AccountCount": { "description": "The results count for each account.", "type": "object", "properties": { "count": { "description": "The number of results (messages or files) found for this account.", "type": "string", "format": "int64" }, "account": { "$ref": "UserInfo", "description": "Account owner." } }, "id": "AccountCount" }, "AddHeldAccountsResponse": { "type": "object", "id": "AddHeldAccountsResponse", "description": "Response for batch create held accounts.", "properties": { "responses": { "type": "array", "description": "The list of responses, in the same order as the batch request.", "items": { "$ref": "AddHeldAccountResult" } } } }, "MailOptions": { "description": "Additional options for Gmail search", "properties": { "clientSideEncryptedOption": { "description": "Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.", "enum": [ "CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED", "CLIENT_SIDE_ENCRYPTED_OPTION_ANY", "CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED", "CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED" ], "type": "string", "enumDescriptions": [ "Encryption status unspecified. Results include both client-side encrypted and non-encrypted content.", "Include both client-side encrypted and unencrypted content in results.", "Include client-side encrypted content only.", "Include unencrypted content only." ] }, "excludeDrafts": { "description": "Set to **true** to exclude drafts.", "type": "boolean" } }, "type": "object", "id": "MailOptions" }, "CountArtifactsRequest": { "description": "Count artifacts request.", "properties": { "query": { "$ref": "Query", "description": "The search query." }, "view": { "enumDescriptions": [ "Default. Same as **TOTAL_COUNT**.", "Response includes counts of the total accounts, queried accounts, matching accounts, non-queryable accounts, and queried account errors.", "Response includes the same details as **TOTAL_COUNT**, plus additional account breakdown." ], "type": "string", "description": "Sets the granularity of the count results.", "enum": [ "COUNT_RESULT_VIEW_UNSPECIFIED", "TOTAL_COUNT", "ALL" ] } }, "type": "object", "id": "CountArtifactsRequest" }, "ListExportsResponse": { "id": "ListExportsResponse", "description": "The exports for a matter.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "Page token to retrieve the next page of results in the list." }, "exports": { "description": "The list of exports.", "type": "array", "items": { "$ref": "Export" } } } }, "UserInfo": { "description": "User's information.", "type": "object", "id": "UserInfo", "properties": { "email": { "description": "The email address of the user.", "type": "string" }, "displayName": { "type": "string", "description": "The displayed name of the user." } } }, "DriveDocumentIds": { "description": "Specify Drive documents by document ID.", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "Required. A list of Drive document IDs." } }, "id": "DriveDocumentIds", "type": "object" }, "CorpusQuery": { "id": "CorpusQuery", "description": "Service-specific options for holds.", "properties": { "driveQuery": { "description": "Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.", "$ref": "HeldDriveQuery" }, "hangoutsChatQuery": { "$ref": "HeldHangoutsChatQuery", "description": "Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**." }, "voiceQuery": { "$ref": "HeldVoiceQuery", "description": "Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**." }, "groupsQuery": { "$ref": "HeldGroupsQuery", "description": "Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**." }, "mailQuery": { "description": "Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.", "$ref": "HeldMailQuery" }, "geminiQuery": { "$ref": "HeldGeminiQuery", "description": "Service-specific options for Gemini holds. If set, **CorpusType** must be **GEMINI**." }, "calendarQuery": { "description": "Service-specific options for Calendar holds. If set, **CorpusType** must be **CALENDAR**.", "$ref": "HeldCalendarQuery" } }, "type": "object" }, "AddHeldAccountsRequest": { "properties": { "emails": { "description": "A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.", "items": { "type": "string" }, "type": "array" }, "accountIds": { "description": "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.", "type": "array", "items": { "type": "string" } } }, "type": "object", "id": "AddHeldAccountsRequest", "description": "Add a list of accounts to a hold." }, "GroupsExportOptions": { "id": "GroupsExportOptions", "properties": { "exportFormat": { "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "type": "string", "description": "The file format for exported messages." } }, "description": "Options for Groups exports.", "type": "object" }, "HeldMailQuery": { "description": "Query options for Gmail holds.", "properties": { "endTime": { "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "type": "string", "format": "google-datetime" }, "startTime": { "format": "google-datetime", "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "type": "string" }, "terms": { "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.", "type": "string" } }, "id": "HeldMailQuery", "type": "object" }, "HeldCalendarQuery": { "id": "HeldCalendarQuery", "description": "Options for Calendar holds.", "type": "object", "properties": {} }, "CloudStorageFile": { "type": "object", "id": "CloudStorageFile", "description": "The export file in Cloud Storage", "properties": { "bucketName": { "description": "The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.", "type": "string" }, "size": { "type": "string", "format": "int64", "description": "The export file size." }, "md5Hash": { "type": "string", "description": "The md5 hash of the file." }, "objectName": { "description": "The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).", "type": "string" } } }, "RemoveMatterPermissionsRequest": { "description": "Remove an account as a matter collaborator.", "id": "RemoveMatterPermissionsRequest", "properties": { "accountId": { "description": "The account ID.", "type": "string" } }, "type": "object" }, "SavedQuery": { "description": "The definition of a saved query. 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.", "id": "SavedQuery", "type": "object", "properties": { "createTime": { "type": "string", "description": "Output only. The server-generated timestamp when the saved query was created.", "format": "google-datetime" }, "matterId": { "type": "string", "description": "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": { "$ref": "Query", "description": "The search parameters of the saved query." }, "savedQueryId": { "type": "string", "description": "A unique identifier for the saved query." }, "displayName": { "description": "The name of the saved query.", "type": "string" } } }, "TeamDriveInfo": { "id": "TeamDriveInfo", "deprecated": true, "description": "Team Drives to search", "type": "object", "properties": { "teamDriveIds": { "type": "array", "deprecated": true, "description": "List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).", "items": { "type": "string" } } } }, "GeminiOptions": { "properties": {}, "id": "GeminiOptions", "description": "Additional options for Gemini search", "type": "object" }, "GroupsCountResult": { "type": "object", "properties": { "matchingAccountsCount": { "description": "Total number of accounts that can be queried and have more than zero messages.", "format": "int64", "type": "string" }, "nonQueryableAccounts": { "items": { "type": "string" }, "type": "array", "description": "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." }, "accountCounts": { "description": "Subtotal count per matching account that have more than zero messages.", "items": { "$ref": "AccountCount" }, "type": "array" }, "queriedAccountsCount": { "format": "int64", "description": "Total number of accounts involved in this count operation.", "type": "string" }, "accountCountErrors": { "type": "array", "description": "Error occurred when querying these accounts.", "items": { "$ref": "AccountCountError" } } }, "id": "GroupsCountResult", "description": "Groups specific count metrics." }, "HeldAccount": { "properties": { "firstName": { "type": "string", "description": "Output only. The first name of the account holder." }, "holdTime": { "type": "string", "description": "Output only. When the account was put on hold.", "format": "google-datetime" }, "lastName": { "type": "string", "description": "Output only. The last name of the account holder." }, "email": { "description": "The primary email address of the account. If used as an input, this takes precedence over **accountId**.", "type": "string" }, "accountId": { "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).", "type": "string" } }, "description": "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.", "type": "object", "id": "HeldAccount" }, "ListSavedQueriesResponse": { "type": "object", "description": "Definition of the response for method ListSaveQuery.", "id": "ListSavedQueriesResponse", "properties": { "nextPageToken": { "type": "string", "description": "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": { "items": { "$ref": "SavedQuery" }, "type": "array", "description": "List of saved queries." } } }, "OrgUnitInfo": { "description": "The organizational unit to search", "type": "object", "id": "OrgUnitInfo", "properties": { "orgUnitId": { "description": "The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).", "type": "string" } } }, "GeminiExportOptions": { "type": "object", "description": "The options for Gemini exports.", "id": "GeminiExportOptions", "properties": { "exportFormat": { "type": "string", "description": "The file format for exported messages.", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ] } } }, "ExportOptions": { "type": "object", "description": "Additional options for exports", "id": "ExportOptions", "properties": { "region": { "type": "string", "enumDescriptions": [ "The region is unspecified. Defaults to ANY.", "Any region.", "United States region.", "Europe region." ], "enum": [ "EXPORT_REGION_UNSPECIFIED", "ANY", "US", "EUROPE" ], "description": "The requested data region for the export." }, "mailOptions": { "$ref": "MailExportOptions", "description": "Options for Gmail exports." }, "voiceOptions": { "$ref": "VoiceExportOptions", "description": "Options for Voice exports." }, "geminiOptions": { "description": "Option available for Gemini export.", "$ref": "GeminiExportOptions" }, "driveOptions": { "$ref": "DriveExportOptions", "description": "Options for Drive exports." }, "hangoutsChatOptions": { "$ref": "HangoutsChatExportOptions", "description": "Options for Chat exports." }, "groupsOptions": { "$ref": "GroupsExportOptions", "description": "Options for Groups exports." }, "calendarOptions": { "description": "Option available for Calendar export.", "$ref": "CalendarExportOptions" } } }, "CloseMatterRequest": { "properties": {}, "id": "CloseMatterRequest", "type": "object", "description": "Close a matter by ID." }, "CalendarExportOptions": { "id": "CalendarExportOptions", "type": "object", "properties": { "exportFormat": { "type": "string", "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "description": "The file format for exported text messages.", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ] } }, "description": "The options for Calendar exports." }, "MatterPermission": { "properties": { "accountId": { "type": "string", "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/)." }, "role": { "type": "string", "enumDescriptions": [ "No role assigned.", "A collaborator on the matter.", "The owner of the matter." ], "enum": [ "ROLE_UNSPECIFIED", "COLLABORATOR", "OWNER" ], "description": "The user's role for the matter." } }, "type": "object", "description": "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.", "id": "MatterPermission" }, "CountArtifactsMetadata": { "id": "CountArtifactsMetadata", "type": "object", "description": "Long running operation metadata for CountArtifacts.", "properties": { "startTime": { "type": "string", "description": "Creation time of count operation.", "format": "google-datetime" }, "query": { "description": "The search query from the request.", "$ref": "Query" }, "endTime": { "description": "End time of count operation. Available when operation is done.", "type": "string", "format": "google-datetime" }, "matterId": { "type": "string", "description": "The matter ID of the associated matter." } } }, "HeldGeminiQuery": { "type": "object", "id": "HeldGeminiQuery", "properties": {}, "description": "Options for Gemini holds." }, "Hold": { "description": "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.", "id": "Hold", "properties": { "accounts": { "description": "If set, the hold applies to the specified accounts and **orgUnit** must be empty.", "items": { "$ref": "HeldAccount" }, "type": "array" }, "holdId": { "type": "string", "description": "The unique immutable ID of the hold. Assigned during creation." }, "updateTime": { "description": "The last time this hold was modified.", "format": "google-datetime", "type": "string" }, "query": { "description": "Service-specific options. If set, **CorpusQuery** must match **CorpusType**.", "$ref": "CorpusQuery" }, "orgUnit": { "description": "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 **accounts**.", "$ref": "HeldOrgUnit" }, "name": { "type": "string", "description": "The name of the hold." }, "corpus": { "description": "The service to be searched.", "enum": [ "CORPUS_TYPE_UNSPECIFIED", "DRIVE", "MAIL", "GROUPS", "HANGOUTS_CHAT", "VOICE", "CALENDAR", "GEMINI" ], "enumDescriptions": [ "No service specified.", "Drive, including Meet and Sites.", "For search, Gmail and classic Hangouts. For holds, Gmail only.", "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", "Calendar.", "Gemini." ], "type": "string" } }, "type": "object" }, "HangoutsChatExportOptions": { "id": "HangoutsChatExportOptions", "description": "Options for Chat exports.", "properties": { "exportFormat": { "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "description": "The file format for exported messages.", "type": "string", "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ] } }, "type": "object" }, "ExportStats": { "id": "ExportStats", "properties": { "exportedArtifactCount": { "description": "The number of messages or files already processed for export.", "type": "string", "format": "int64" }, "totalArtifactCount": { "format": "int64", "description": "The number of messages or files to be exported.", "type": "string" }, "sizeInBytes": { "description": "The size of export in bytes.", "format": "int64", "type": "string" } }, "description": "Progress information for an export.", "type": "object" }, "Status": { "type": "object", "description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "message": { "type": "string", "description": "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." }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } }, "id": "Status" }, "ReopenMatterResponse": { "type": "object", "properties": { "matter": { "description": "The updated matter, with state **OPEN**.", "$ref": "Matter" } }, "id": "ReopenMatterResponse", "description": "Response to a ReopenMatterRequest." }, "SitesUrlInfo": { "type": "object", "properties": { "urls": { "type": "array", "description": "A list of published site URLs.", "items": { "type": "string" } } }, "description": "The published site URLs of new Google Sites to search", "id": "SitesUrlInfo" }, "MailCountResult": { "type": "object", "properties": { "accountCounts": { "items": { "$ref": "AccountCount" }, "description": "Subtotal count per matching account that have more than zero messages.", "type": "array" }, "nonQueryableAccounts": { "type": "array", "items": { "type": "string" }, "description": "When **DataScope** is **HELD_DATA** and when account emails are passed in explicitly, the list of accounts in the request that are not queried because they are not on hold in the matter. For other data scopes, this field is not set." }, "matchingAccountsCount": { "type": "string", "description": "Total number of accounts that can be queried and have more than zero messages.", "format": "int64" }, "queriedAccountsCount": { "format": "int64", "type": "string", "description": "Total number of accounts involved in this count operation." }, "accountCountErrors": { "type": "array", "items": { "$ref": "AccountCountError" }, "description": "Errors occurred when querying these accounts." } }, "description": "Gmail and classic Hangouts-specific count metrics.", "id": "MailCountResult" } }, "servicePath": "", "title": "Google Vault API", "basePath": "", "version_module": true, "rootUrl": "https://vault.googleapis.com/", "baseUrl": "https://vault.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/ediscovery.readonly": { "description": "View your eDiscovery data" }, "https://www.googleapis.com/auth/ediscovery": { "description": "Manage your eDiscovery data" } } } }, "parameters": { "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "prettyPrint": { "default": "true", "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean" }, "alt": { "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response.", "type": "string" }, "$.xgafv": { "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "quotaUser": { "type": "string", "location": "query", "description": "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." }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "documentationLink": "https://developers.google.com/workspace/vault", "protocol": "rest", "revision": "20260905", "ownerDomain": "google.com", "ownerName": "Google", "fullyEncodeReservedExpansion": true, "canonicalName": "Vault", "name": "vault", "mtlsRootUrl": "https://vault.mtls.googleapis.com/", "resources": { "operations": { "methods": { "cancel": { "response": { "$ref": "Empty" }, "description": "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`.", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "pattern": "^operations/.*$", "description": "The name of the operation resource to be cancelled.", "type": "string" } }, "id": "vault.operations.cancel", "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "path": "v1/{+name}:cancel", "flatPath": "v1/operations/{operationsId}:cancel" }, "get": { "flatPath": "v1/operations/{operationsId}", "id": "vault.operations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^operations/.*$", "description": "The name of the operation resource.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "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.", "response": { "$ref": "Operation" } }, "list": { "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}", "id": "vault.operations.list", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "flatPath": "v1/operations", "httpMethod": "GET", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "name": { "type": "string", "location": "path", "required": true, "description": "The name of the operation's parent resource.", "pattern": "^operations$" } } }, "delete": { "description": "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`.", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/operations/{operationsId}", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^operations/.*$" } }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "vault.operations.delete" } } }, "matters": { "methods": { "close": { "description": "Closes the specified matter. Returns the matter with updated state.", "httpMethod": "POST", "parameters": { "matterId": { "location": "path", "required": true, "type": "string", "description": "The matter ID." } }, "flatPath": "v1/matters/{matterId}:close", "request": { "$ref": "CloseMatterRequest" }, "path": "v1/matters/{matterId}:close", "response": { "$ref": "CloseMatterResponse" }, "parameterOrder": [ "matterId" ], "id": "vault.matters.close", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ] }, "list": { "flatPath": "v1/matters", "httpMethod": "GET", "parameters": { "pageToken": { "description": "The pagination token as returned in the response.", "type": "string", "location": "query" }, "view": { "type": "string", "description": "Specifies how much information about the matter to return in response.", "enum": [ "VIEW_UNSPECIFIED", "BASIC", "FULL" ], "location": "query", "enumDescriptions": [ "The amount of detail is unspecified. Same as **BASIC**.", "Returns the matter ID, name, description, and state. Default choice.", "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission))." ] }, "state": { "description": "If set, lists only matters with the specified state. The default lists matters of all states.", "enumDescriptions": [ "The matter has no specified state.", "The matter is open.", "The matter is closed.", "The matter is deleted." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "OPEN", "CLOSED", "DELETED" ], "location": "query" }, "pageSize": { "description": "The number of matters to return in the response. Default and maximum are 100.", "type": "integer", "format": "int32", "location": "query" } }, "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "id": "vault.matters.list", "path": "v1/matters", "description": "Lists matters the requestor has access to.", "response": { "$ref": "ListMattersResponse" } }, "undelete": { "response": { "$ref": "Matter" }, "id": "vault.matters.undelete", "request": { "$ref": "UndeleteMatterRequest" }, "parameterOrder": [ "matterId" ], "httpMethod": "POST", "parameters": { "matterId": { "location": "path", "required": true, "description": "The matter ID.", "type": "string" } }, "path": "v1/matters/{matterId}:undelete", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "description": "Undeletes the specified matter. Returns the matter with updated state.", "flatPath": "v1/matters/{matterId}:undelete" }, "addPermissions": { "response": { "$ref": "MatterPermission" }, "path": "v1/matters/{matterId}:addPermissions", "id": "vault.matters.addPermissions", "httpMethod": "POST", "parameters": { "matterId": { "description": "The matter ID.", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "AddMatterPermissionsRequest" }, "description": "Adds an account as a matter collaborator.", "flatPath": "v1/matters/{matterId}:addPermissions", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [ "matterId" ] }, "count": { "path": "v1/matters/{matterId}:count", "parameterOrder": [ "matterId" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "request": { "$ref": "CountArtifactsRequest" }, "httpMethod": "POST", "parameters": { "matterId": { "type": "string", "location": "path", "required": true, "description": "The matter ID." } }, "flatPath": "v1/matters/{matterId}:count", "description": "Counts the accounts processed by the specified query.", "id": "vault.matters.count" }, "removePermissions": { "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}:removePermissions", "id": "vault.matters.removePermissions", "parameterOrder": [ "matterId" ], "request": { "$ref": "RemoveMatterPermissionsRequest" }, "path": "v1/matters/{matterId}:removePermissions", "httpMethod": "POST", "parameters": { "matterId": { "location": "path", "required": true, "type": "string", "description": "The matter ID." } }, "description": "Removes an account as a matter collaborator.", "response": { "$ref": "Empty" } }, "reopen": { "flatPath": "v1/matters/{matterId}:reopen", "parameterOrder": [ "matterId" ], "id": "vault.matters.reopen", "request": { "$ref": "ReopenMatterRequest" }, "response": { "$ref": "ReopenMatterResponse" }, "path": "v1/matters/{matterId}:reopen", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "description": "Reopens the specified matter. Returns the matter with updated state.", "httpMethod": "POST", "parameters": { "matterId": { "location": "path", "required": true, "description": "The matter ID.", "type": "string" } } }, "delete": { "flatPath": "v1/matters/{matterId}", "id": "vault.matters.delete", "path": "v1/matters/{matterId}", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [ "matterId" ], "response": { "$ref": "Matter" }, "httpMethod": "DELETE", "parameters": { "matterId": { "description": "The matter ID", "location": "path", "required": true, "type": "string" } }, "description": "Deletes the specified matter. Returns the matter with updated state." }, "get": { "description": "Gets the specified matter.", "path": "v1/matters/{matterId}", "id": "vault.matters.get", "flatPath": "v1/matters/{matterId}", "response": { "$ref": "Matter" }, "httpMethod": "GET", "parameters": { "matterId": { "type": "string", "location": "path", "required": true, "description": "The matter ID." }, "view": { "type": "string", "enum": [ "VIEW_UNSPECIFIED", "BASIC", "FULL" ], "location": "query", "description": "Specifies how much information about the matter to return in the response.", "enumDescriptions": [ "The amount of detail is unspecified. Same as **BASIC**.", "Returns the matter ID, name, description, and state. Default choice.", "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission))." ] } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "parameterOrder": [ "matterId" ] }, "create": { "description": "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.", "request": { "$ref": "Matter" }, "flatPath": "v1/matters", "id": "vault.matters.create", "path": "v1/matters", "httpMethod": "POST", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [], "response": { "$ref": "Matter" } }, "update": { "response": { "$ref": "Matter" }, "id": "vault.matters.update", "parameterOrder": [ "matterId" ], "description": "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.", "path": "v1/matters/{matterId}", "request": { "$ref": "Matter" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "PUT", "parameters": { "matterId": { "description": "The matter ID.", "location": "path", "required": true, "type": "string" } }, "flatPath": "v1/matters/{matterId}" } }, "resources": { "holds": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "path": "v1/matters/{matterId}/holds/{holdId}", "description": "Gets the specified hold.", "httpMethod": "GET", "parameters": { "holdId": { "description": "The hold ID.", "location": "path", "required": true, "type": "string" }, "matterId": { "type": "string", "location": "path", "required": true, "description": "The matter ID." }, "view": { "description": "The amount of detail to return for a hold.", "enumDescriptions": [ "Not specified. Defaults to **FULL_HOLD**.", "Returns the hold ID, name, update time, service, and query.", "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit." ], "type": "string", "location": "query", "enum": [ "HOLD_VIEW_UNSPECIFIED", "BASIC_HOLD", "FULL_HOLD" ] } }, "flatPath": "v1/matters/{matterId}/holds/{holdId}", "response": { "$ref": "Hold" }, "id": "vault.matters.holds.get", "parameterOrder": [ "matterId", "holdId" ] }, "addHeldAccounts": { "path": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts", "httpMethod": "POST", "parameters": { "holdId": { "location": "path", "required": true, "type": "string", "description": "The hold ID." }, "matterId": { "description": "The matter ID.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "matterId", "holdId" ], "flatPath": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "request": { "$ref": "AddHeldAccountsRequest" }, "description": "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.", "id": "vault.matters.holds.addHeldAccounts", "response": { "$ref": "AddHeldAccountsResponse" } }, "delete": { "description": "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.", "httpMethod": "DELETE", "parameters": { "holdId": { "description": "The hold ID.", "location": "path", "required": true, "type": "string" }, "matterId": { "type": "string", "location": "path", "required": true, "description": "The matter ID." } }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}/holds/{holdId}", "parameterOrder": [ "matterId", "holdId" ], "path": "v1/matters/{matterId}/holds/{holdId}", "id": "vault.matters.holds.delete" }, "list": { "description": "Lists the holds in a matter.", "id": "vault.matters.holds.list", "response": { "$ref": "ListHoldsResponse" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "flatPath": "v1/matters/{matterId}/holds", "parameterOrder": [ "matterId" ], "path": "v1/matters/{matterId}/holds", "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "The pagination token as returned in the response. An empty token means start from the beginning.", "type": "string" }, "matterId": { "description": "The matter ID.", "type": "string", "location": "path", "required": true }, "pageSize": { "location": "query", "description": "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.", "format": "int32", "type": "integer" }, "view": { "type": "string", "enum": [ "HOLD_VIEW_UNSPECIFIED", "BASIC_HOLD", "FULL_HOLD" ], "enumDescriptions": [ "Not specified. Defaults to **FULL_HOLD**.", "Returns the hold ID, name, update time, service, and query.", "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit." ], "location": "query", "description": "The amount of detail to return for a hold." } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "path": "v1/matters/{matterId}/holds", "flatPath": "v1/matters/{matterId}/holds", "id": "vault.matters.holds.create", "description": "Creates a hold in the specified matter.", "response": { "$ref": "Hold" }, "httpMethod": "POST", "parameters": { "matterId": { "description": "The matter ID.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "matterId" ], "request": { "$ref": "Hold" } }, "update": { "parameterOrder": [ "matterId", "holdId" ], "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}/holds/{holdId}", "response": { "$ref": "Hold" }, "request": { "$ref": "Hold" }, "id": "vault.matters.holds.update", "path": "v1/matters/{matterId}/holds/{holdId}", "httpMethod": "PUT", "parameters": { "holdId": { "description": "The ID of the hold.", "type": "string", "location": "path", "required": true }, "matterId": { "description": "The matter ID.", "type": "string", "location": "path", "required": true } }, "description": "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." }, "removeHeldAccounts": { "flatPath": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts", "request": { "$ref": "RemoveHeldAccountsRequest" }, "httpMethod": "POST", "parameters": { "matterId": { "type": "string", "description": "The matter ID.", "location": "path", "required": true }, "holdId": { "location": "path", "required": true, "type": "string", "description": "The hold ID." } }, "parameterOrder": [ "matterId", "holdId" ], "id": "vault.matters.holds.removeHeldAccounts", "response": { "$ref": "RemoveHeldAccountsResponse" }, "path": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts", "description": "Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ] } }, "resources": { "accounts": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "description": "Removes an account from a hold.", "httpMethod": "DELETE", "parameters": { "accountId": { "description": "The ID of the account to remove from the hold.", "location": "path", "required": true, "type": "string" }, "matterId": { "description": "The matter ID.", "location": "path", "required": true, "type": "string" }, "holdId": { "location": "path", "required": true, "type": "string", "description": "The hold ID." } }, "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", "id": "vault.matters.holds.accounts.delete", "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", "response": { "$ref": "Empty" }, "parameterOrder": [ "matterId", "holdId", "accountId" ] }, "create": { "httpMethod": "POST", "parameters": { "holdId": { "type": "string", "description": "The hold ID.", "location": "path", "required": true }, "matterId": { "type": "string", "location": "path", "required": true, "description": "The matter ID." } }, "response": { "$ref": "HeldAccount" }, "request": { "$ref": "HeldAccount" }, "id": "vault.matters.holds.accounts.create", "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", "path": "v1/matters/{matterId}/holds/{holdId}/accounts", "description": "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.", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [ "matterId", "holdId" ] }, "list": { "id": "vault.matters.holds.accounts.list", "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", "parameterOrder": [ "matterId", "holdId" ], "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "description": "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](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.", "path": "v1/matters/{matterId}/holds/{holdId}/accounts", "httpMethod": "GET", "parameters": { "holdId": { "type": "string", "location": "path", "required": true, "description": "The hold ID." }, "matterId": { "type": "string", "description": "The matter ID.", "location": "path", "required": true } }, "response": { "$ref": "ListHeldAccountsResponse" } } } } } }, "savedQueries": { "methods": { "list": { "httpMethod": "GET", "parameters": { "pageToken": { "description": "The pagination token as returned in the previous response. An empty token means start from the beginning.", "location": "query", "type": "string" }, "matterId": { "type": "string", "location": "path", "required": true, "description": "The ID of the matter to get the saved queries for." }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of saved queries to return.", "type": "integer" } }, "path": "v1/matters/{matterId}/savedQueries", "parameterOrder": [ "matterId" ], "id": "vault.matters.savedQueries.list", "flatPath": "v1/matters/{matterId}/savedQueries", "description": "Lists the saved queries in a matter.", "response": { "$ref": "ListSavedQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ] }, "delete": { "parameterOrder": [ "matterId", "savedQueryId" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "parameters": { "matterId": { "description": "The ID of the matter to delete the saved query from.", "location": "path", "required": true, "type": "string" }, "savedQueryId": { "location": "path", "required": true, "type": "string", "description": "ID of the saved query to delete." } }, "path": "v1/matters/{matterId}/savedQueries/{savedQueryId}", "description": "Deletes the specified saved query.", "id": "vault.matters.savedQueries.delete", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}" }, "get": { "response": { "$ref": "SavedQuery" }, "flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}", "id": "vault.matters.savedQueries.get", "path": "v1/matters/{matterId}/savedQueries/{savedQueryId}", "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "parameterOrder": [ "matterId", "savedQueryId" ], "httpMethod": "GET", "parameters": { "savedQueryId": { "location": "path", "required": true, "type": "string", "description": "ID of the saved query to retrieve." }, "matterId": { "location": "path", "required": true, "type": "string", "description": "The ID of the matter to get the saved query from." } }, "description": "Retrieves the specified saved query." }, "create": { "id": "vault.matters.savedQueries.create", "flatPath": "v1/matters/{matterId}/savedQueries", "description": "Creates a saved query.", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "POST", "parameters": { "matterId": { "type": "string", "description": "The ID of the matter to create the saved query in.", "location": "path", "required": true } }, "response": { "$ref": "SavedQuery" }, "path": "v1/matters/{matterId}/savedQueries", "parameterOrder": [ "matterId" ], "request": { "$ref": "SavedQuery" } } } }, "exports": { "methods": { "get": { "description": "Gets an export.", "httpMethod": "GET", "parameters": { "matterId": { "description": "The matter ID.", "type": "string", "location": "path", "required": true }, "exportId": { "location": "path", "required": true, "type": "string", "description": "The export ID." } }, "id": "vault.matters.exports.get", "flatPath": "v1/matters/{matterId}/exports/{exportId}", "parameterOrder": [ "matterId", "exportId" ], "response": { "$ref": "Export" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "path": "v1/matters/{matterId}/exports/{exportId}" }, "create": { "request": { "$ref": "Export" }, "httpMethod": "POST", "parameters": { "matterId": { "location": "path", "required": true, "type": "string", "description": "The matter ID." } }, "response": { "$ref": "Export" }, "parameterOrder": [ "matterId" ], "flatPath": "v1/matters/{matterId}/exports", "id": "vault.matters.exports.create", "path": "v1/matters/{matterId}/exports", "description": "Creates an export.", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ] }, "list": { "description": "Lists details about the exports in the specified matter.", "httpMethod": "GET", "parameters": { "matterId": { "location": "path", "required": true, "type": "string", "description": "The matter ID." }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The number of exports to return in the response." }, "pageToken": { "description": "The pagination token as returned in the response.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "id": "vault.matters.exports.list", "response": { "$ref": "ListExportsResponse" }, "parameterOrder": [ "matterId" ], "flatPath": "v1/matters/{matterId}/exports", "path": "v1/matters/{matterId}/exports" }, "delete": { "id": "vault.matters.exports.delete", "parameterOrder": [ "matterId", "exportId" ], "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}/exports/{exportId}", "httpMethod": "DELETE", "parameters": { "matterId": { "description": "The matter ID.", "type": "string", "location": "path", "required": true }, "exportId": { "location": "path", "required": true, "description": "The export ID.", "type": "string" } }, "response": { "$ref": "Empty" }, "description": "Deletes an export.", "path": "v1/matters/{matterId}/exports/{exportId}" } } } } } }, "id": "vault:v1" }