blob: e89c05832bbf901c682ed56bcd1eec4fffcc361e [file] [log] [blame]
<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">G Suite 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.
&quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
&quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
&quot;bucketName&quot;: &quot;A String&quot;, # 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.
&quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
&quot;objectName&quot;: &quot;A String&quot;, # 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).
&quot;size&quot;: &quot;A String&quot;, # The export file size.
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
&quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
&quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
&quot;includeAccessInfo&quot;: 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**.
},
&quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
&quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
},
&quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
&quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
},
},
&quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
&quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
&quot;name&quot;: &quot;A String&quot;, # The export name.
&quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
&quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
&quot;emails&quot;: [ # A set of accounts to search.
&quot;A String&quot;,
],
},
&quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
&quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
&quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
&quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
&quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
&quot;versionDate&quot;: &quot;A String&quot;, # 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.
},
&quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
&quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
&quot;A String&quot;,
],
},
&quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
&quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
&quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
&quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
},
&quot;method&quot;: &quot;A String&quot;, # 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**.
&quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
&quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
&quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
&quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
&quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
&quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
&quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. 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).
&quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
&quot;coveredData&quot;: [ # Datatypes to search
&quot;A String&quot;,
],
},
},
&quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
&quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
&quot;email&quot;: &quot;A String&quot;, # The email address of the user.
},
&quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
&quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
&quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
&quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
},
&quot;status&quot;: &quot;A String&quot;, # 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.
&quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
&quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
&quot;bucketName&quot;: &quot;A String&quot;, # 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.
&quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
&quot;objectName&quot;: &quot;A String&quot;, # 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).
&quot;size&quot;: &quot;A String&quot;, # The export file size.
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
&quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
&quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
&quot;includeAccessInfo&quot;: 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**.
},
&quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
&quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
},
&quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
&quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
},
},
&quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
&quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
&quot;name&quot;: &quot;A String&quot;, # The export name.
&quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
&quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
&quot;emails&quot;: [ # A set of accounts to search.
&quot;A String&quot;,
],
},
&quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
&quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
&quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
&quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
&quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
&quot;versionDate&quot;: &quot;A String&quot;, # 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.
},
&quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
&quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
&quot;A String&quot;,
],
},
&quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
&quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
&quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
&quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
},
&quot;method&quot;: &quot;A String&quot;, # 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**.
&quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
&quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
&quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
&quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
&quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
&quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
&quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. 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).
&quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
&quot;coveredData&quot;: [ # Datatypes to search
&quot;A String&quot;,
],
},
},
&quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
&quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
&quot;email&quot;: &quot;A String&quot;, # The email address of the user.
},
&quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
&quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
&quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
&quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
},
&quot;status&quot;: &quot;A String&quot;, # 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.
&quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
&quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
&quot;bucketName&quot;: &quot;A String&quot;, # 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.
&quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
&quot;objectName&quot;: &quot;A String&quot;, # 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).
&quot;size&quot;: &quot;A String&quot;, # The export file size.
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
&quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
&quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
&quot;includeAccessInfo&quot;: 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**.
},
&quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
&quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
},
&quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
&quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
},
},
&quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
&quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
&quot;name&quot;: &quot;A String&quot;, # The export name.
&quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
&quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
&quot;emails&quot;: [ # A set of accounts to search.
&quot;A String&quot;,
],
},
&quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
&quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
&quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
&quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
&quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
&quot;versionDate&quot;: &quot;A String&quot;, # 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.
},
&quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
&quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
&quot;A String&quot;,
],
},
&quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
&quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
&quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
&quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
},
&quot;method&quot;: &quot;A String&quot;, # 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**.
&quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
&quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
&quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
&quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
&quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
&quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
&quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. 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).
&quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
&quot;coveredData&quot;: [ # Datatypes to search
&quot;A String&quot;,
],
},
},
&quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
&quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
&quot;email&quot;: &quot;A String&quot;, # The email address of the user.
},
&quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
&quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
&quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
&quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
},
&quot;status&quot;: &quot;A String&quot;, # 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.
&quot;exports&quot;: [ # 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.
&quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
&quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
&quot;bucketName&quot;: &quot;A String&quot;, # 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.
&quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
&quot;objectName&quot;: &quot;A String&quot;, # 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).
&quot;size&quot;: &quot;A String&quot;, # The export file size.
},
],
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
&quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
&quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
&quot;includeAccessInfo&quot;: 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**.
},
&quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
},
&quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
&quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
},
&quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
&quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
&quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
},
},
&quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
&quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
&quot;name&quot;: &quot;A String&quot;, # The export name.
&quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
&quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
&quot;emails&quot;: [ # A set of accounts to search.
&quot;A String&quot;,
],
},
&quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
&quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
&quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
&quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
&quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
&quot;versionDate&quot;: &quot;A String&quot;, # 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.
},
&quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
&quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
&quot;A String&quot;,
],
},
&quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
&quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
&quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
&quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
},
&quot;method&quot;: &quot;A String&quot;, # 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**.
&quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
&quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
&quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
&quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
&quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
&quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
&quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
&quot;A String&quot;,
],
},
&quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
&quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. 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).
&quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
&quot;coveredData&quot;: [ # Datatypes to search
&quot;A String&quot;,
],
},
},
&quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
&quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
&quot;email&quot;: &quot;A String&quot;, # The email address of the user.
},
&quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
&quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
&quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
&quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
},
&quot;status&quot;: &quot;A String&quot;, # Output only. The status of the export.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>