570 lines
36 KiB
HTML
570 lines
36 KiB
HTML
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.exports.html">exports</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#close">close()</a></code></p>
|
|
<p class="firstline">Close httplib2 connections.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates an export.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(matterId, exportId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Deletes an export.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(matterId, exportId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets an export.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Lists details about the exports in the specified matter.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
|
|
<pre>Creates an export.
|
|
|
|
Args:
|
|
matterId: string, The matter ID. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # 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.
|
|
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
|
|
"files": [ # Output only. The exported files in Cloud Storage.
|
|
{ # The export file in Cloud Storage
|
|
"bucketName": "A 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](https://cloud.google.com/storage/docs/apis), 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.
|
|
"md5Hash": "A String", # The md5 hash of the file.
|
|
"objectName": "A 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](https://cloud.google.com/storage/docs/apis).
|
|
"size": "A String", # The export file size.
|
|
},
|
|
],
|
|
},
|
|
"createTime": "A String", # Output only. The time when the export was created.
|
|
"exportOptions": { # Additional options for exports # Additional export options.
|
|
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
|
|
"includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
|
|
},
|
|
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
|
|
},
|
|
"region": "A String", # The requested data region for the export.
|
|
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
|
|
"exportFormat": "A String", # The file format for exported text messages.
|
|
},
|
|
},
|
|
"id": "A String", # Output only. The generated export ID.
|
|
"matterId": "A String", # Output only. The matter ID.
|
|
"name": "A String", # The export name.
|
|
"query": { # The query definition used for search and export. # The query parameters used to create the export.
|
|
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
|
|
"emails": [ # A set of accounts to search.
|
|
"A String",
|
|
],
|
|
},
|
|
"corpus": "A String", # The Google Workspace service to search.
|
|
"dataScope": "A String", # The data source to search.
|
|
"driveOptions": { # Additional options for Drive search # Set Drive search-specific options.
|
|
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
|
|
"includeTeamDrives": True or False, # Set to true to include Team Drive.
|
|
"versionDate": "A 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.
|
|
},
|
|
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
|
|
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
|
|
"A String",
|
|
],
|
|
},
|
|
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
|
|
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
|
|
},
|
|
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
|
|
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
|
|
},
|
|
"method": "A 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": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
|
|
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
|
|
},
|
|
"searchMethod": "A String", # The search method to use.
|
|
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
|
|
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
|
|
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
|
|
"timeZone": "A 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](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).
|
|
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
|
|
"coveredData": [ # Datatypes to search
|
|
"A String",
|
|
],
|
|
},
|
|
},
|
|
"requester": { # User's information. # Output only. The requester of the export.
|
|
"displayName": "A String", # The displayed name of the user.
|
|
"email": "A String", # The email address of the user.
|
|
},
|
|
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
|
|
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
|
|
"sizeInBytes": "A String", # The size of export in bytes.
|
|
"totalArtifactCount": "A String", # The number of messages or files to be exported.
|
|
},
|
|
"status": "A String", # Output only. The status of the export.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # 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.
|
|
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
|
|
"files": [ # Output only. The exported files in Cloud Storage.
|
|
{ # The export file in Cloud Storage
|
|
"bucketName": "A 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](https://cloud.google.com/storage/docs/apis), 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.
|
|
"md5Hash": "A String", # The md5 hash of the file.
|
|
"objectName": "A 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](https://cloud.google.com/storage/docs/apis).
|
|
"size": "A String", # The export file size.
|
|
},
|
|
],
|
|
},
|
|
"createTime": "A String", # Output only. The time when the export was created.
|
|
"exportOptions": { # Additional options for exports # Additional export options.
|
|
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
|
|
"includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
|
|
},
|
|
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
|
|
},
|
|
"region": "A String", # The requested data region for the export.
|
|
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
|
|
"exportFormat": "A String", # The file format for exported text messages.
|
|
},
|
|
},
|
|
"id": "A String", # Output only. The generated export ID.
|
|
"matterId": "A String", # Output only. The matter ID.
|
|
"name": "A String", # The export name.
|
|
"query": { # The query definition used for search and export. # The query parameters used to create the export.
|
|
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
|
|
"emails": [ # A set of accounts to search.
|
|
"A String",
|
|
],
|
|
},
|
|
"corpus": "A String", # The Google Workspace service to search.
|
|
"dataScope": "A String", # The data source to search.
|
|
"driveOptions": { # Additional options for Drive search # Set Drive search-specific options.
|
|
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
|
|
"includeTeamDrives": True or False, # Set to true to include Team Drive.
|
|
"versionDate": "A 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.
|
|
},
|
|
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
|
|
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
|
|
"A String",
|
|
],
|
|
},
|
|
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
|
|
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
|
|
},
|
|
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
|
|
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
|
|
},
|
|
"method": "A 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": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
|
|
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
|
|
},
|
|
"searchMethod": "A String", # The search method to use.
|
|
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
|
|
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
|
|
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
|
|
"timeZone": "A 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](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).
|
|
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
|
|
"coveredData": [ # Datatypes to search
|
|
"A String",
|
|
],
|
|
},
|
|
},
|
|
"requester": { # User's information. # Output only. The requester of the export.
|
|
"displayName": "A String", # The displayed name of the user.
|
|
"email": "A String", # The email address of the user.
|
|
},
|
|
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
|
|
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
|
|
"sizeInBytes": "A String", # The size of export in bytes.
|
|
"totalArtifactCount": "A String", # The number of messages or files to be exported.
|
|
},
|
|
"status": "A String", # Output only. The status of the export.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(matterId, exportId, x__xgafv=None)</code>
|
|
<pre>Deletes an export.
|
|
|
|
Args:
|
|
matterId: string, The matter ID. (required)
|
|
exportId: string, The export ID. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(matterId, exportId, x__xgafv=None)</code>
|
|
<pre>Gets an export.
|
|
|
|
Args:
|
|
matterId: string, The matter ID. (required)
|
|
exportId: string, The export ID. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # 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.
|
|
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
|
|
"files": [ # Output only. The exported files in Cloud Storage.
|
|
{ # The export file in Cloud Storage
|
|
"bucketName": "A 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](https://cloud.google.com/storage/docs/apis), 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.
|
|
"md5Hash": "A String", # The md5 hash of the file.
|
|
"objectName": "A 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](https://cloud.google.com/storage/docs/apis).
|
|
"size": "A String", # The export file size.
|
|
},
|
|
],
|
|
},
|
|
"createTime": "A String", # Output only. The time when the export was created.
|
|
"exportOptions": { # Additional options for exports # Additional export options.
|
|
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
|
|
"includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
|
|
},
|
|
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
|
|
},
|
|
"region": "A String", # The requested data region for the export.
|
|
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
|
|
"exportFormat": "A String", # The file format for exported text messages.
|
|
},
|
|
},
|
|
"id": "A String", # Output only. The generated export ID.
|
|
"matterId": "A String", # Output only. The matter ID.
|
|
"name": "A String", # The export name.
|
|
"query": { # The query definition used for search and export. # The query parameters used to create the export.
|
|
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
|
|
"emails": [ # A set of accounts to search.
|
|
"A String",
|
|
],
|
|
},
|
|
"corpus": "A String", # The Google Workspace service to search.
|
|
"dataScope": "A String", # The data source to search.
|
|
"driveOptions": { # Additional options for Drive search # Set Drive search-specific options.
|
|
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
|
|
"includeTeamDrives": True or False, # Set to true to include Team Drive.
|
|
"versionDate": "A 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.
|
|
},
|
|
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
|
|
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
|
|
"A String",
|
|
],
|
|
},
|
|
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
|
|
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
|
|
},
|
|
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
|
|
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
|
|
},
|
|
"method": "A 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": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
|
|
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
|
|
},
|
|
"searchMethod": "A String", # The search method to use.
|
|
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
|
|
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
|
|
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
|
|
"timeZone": "A 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](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).
|
|
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
|
|
"coveredData": [ # Datatypes to search
|
|
"A String",
|
|
],
|
|
},
|
|
},
|
|
"requester": { # User's information. # Output only. The requester of the export.
|
|
"displayName": "A String", # The displayed name of the user.
|
|
"email": "A String", # The email address of the user.
|
|
},
|
|
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
|
|
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
|
|
"sizeInBytes": "A String", # The size of export in bytes.
|
|
"totalArtifactCount": "A String", # The number of messages or files to be exported.
|
|
},
|
|
"status": "A String", # Output only. The status of the export.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code>
|
|
<pre>Lists details about the exports in the specified matter.
|
|
|
|
Args:
|
|
matterId: string, The matter ID. (required)
|
|
pageSize: integer, The number of exports to return in the response.
|
|
pageToken: string, The pagination token as returned in the response.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # The exports for a matter.
|
|
"exports": [ # The list of exports.
|
|
{ # 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.
|
|
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
|
|
"files": [ # Output only. The exported files in Cloud Storage.
|
|
{ # The export file in Cloud Storage
|
|
"bucketName": "A 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](https://cloud.google.com/storage/docs/apis), 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.
|
|
"md5Hash": "A String", # The md5 hash of the file.
|
|
"objectName": "A 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](https://cloud.google.com/storage/docs/apis).
|
|
"size": "A String", # The export file size.
|
|
},
|
|
],
|
|
},
|
|
"createTime": "A String", # Output only. The time when the export was created.
|
|
"exportOptions": { # Additional options for exports # Additional export options.
|
|
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
|
|
"includeAccessInfo": True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
|
|
},
|
|
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
},
|
|
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
|
|
"exportFormat": "A String", # The file format for exported messages.
|
|
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
|
|
},
|
|
"region": "A String", # The requested data region for the export.
|
|
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
|
|
"exportFormat": "A String", # The file format for exported text messages.
|
|
},
|
|
},
|
|
"id": "A String", # Output only. The generated export ID.
|
|
"matterId": "A String", # Output only. The matter ID.
|
|
"name": "A String", # The export name.
|
|
"query": { # The query definition used for search and export. # The query parameters used to create the export.
|
|
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
|
|
"emails": [ # A set of accounts to search.
|
|
"A String",
|
|
],
|
|
},
|
|
"corpus": "A String", # The Google Workspace service to search.
|
|
"dataScope": "A String", # The data source to search.
|
|
"driveOptions": { # Additional options for Drive search # Set Drive search-specific options.
|
|
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
|
|
"includeTeamDrives": True or False, # Set to true to include Team Drive.
|
|
"versionDate": "A 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.
|
|
},
|
|
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
|
|
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
|
|
"A String",
|
|
],
|
|
},
|
|
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
|
|
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
|
|
},
|
|
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
|
|
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
|
|
},
|
|
"method": "A 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": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
|
|
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
|
|
},
|
|
"searchMethod": "A String", # The search method to use.
|
|
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
|
|
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
|
|
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
|
|
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
|
|
"A String",
|
|
],
|
|
},
|
|
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
|
|
"timeZone": "A 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](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).
|
|
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
|
|
"coveredData": [ # Datatypes to search
|
|
"A String",
|
|
],
|
|
},
|
|
},
|
|
"requester": { # User's information. # Output only. The requester of the export.
|
|
"displayName": "A String", # The displayed name of the user.
|
|
"email": "A String", # The email address of the user.
|
|
},
|
|
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
|
|
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
|
|
"sizeInBytes": "A String", # The size of export in bytes.
|
|
"totalArtifactCount": "A String", # The number of messages or files to be exported.
|
|
},
|
|
"status": "A String", # Output only. The status of the export.
|
|
},
|
|
],
|
|
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
</body></html> |