docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/vault_v1.matters.savedQueries.html b/docs/dyn/vault_v1.matters.savedQueries.html
index 8a571e0..2aca7bf 100644
--- a/docs/dyn/vault_v1.matters.savedQueries.html
+++ b/docs/dyn/vault_v1.matters.savedQueries.html
@@ -75,6 +75,9 @@
<h1><a href="vault_v1.html">G Suite Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.savedQueries.html">savedQueries</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 a saved query.</p>
<p class="toc_element">
@@ -84,98 +87,76 @@
<code><a href="#get">get(matterId, savedQueryId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a saved query by Id.</p>
<p class="toc_element">
- <code><a href="#list">list(matterId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists saved queries within a matter. An empty page token in</p>
+ <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.</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 a saved query.
Args:
- matterId: string, The matter ID of the parent matter for which the saved query is to be
-created. (required)
+ matterId: string, The matter ID of the parent matter for which the saved query is to be created. (required)
body: object, The request body.
The object takes the form of:
{ # Definition of the saved query.
- "createTime": "A String", # Output only. The server generated timestamp at which saved query was
- # created.
- "savedQueryId": "A String", # A unique identifier for the saved query.
- "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
- # query.
- "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
- # account_info needs to be specified.
- "emails": [ # A set of accounts to search.
- "A String",
- ],
- },
- "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
- # specified. (read-only)
- "roomId": [ # A set of rooms to search.
- "A String",
- ],
- },
- "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
- # specified.
- "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "dataScope": "A String", # The data source to search from.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "searchMethod": "A String", # The search method to use.
- "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
- "includeTeamDrives": True or False, # Set to true to include Team Drive.
- "includeSharedDrives": True or False, # Set to true to include shared drive.
- "versionDate": "A String", # Search the versions of the Drive file
- # as of the reference date. These timestamps are in GMT and
- # rounded down to the given date.
- },
- "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
- # to be specified.
- "orgUnitId": "A String", # Org unit to search, as provided by the
- # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
- # Directory API</a>.
- },
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "terms": "A String", # The corpus-specific
- # <a href="https://support.google.com/vault/answer/2474474">search
- # operators</a> used to generate search results.
- "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
- "includeRooms": True or False, # Set to true to include rooms.
- },
- "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
- # to be specified.
- "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
- "excludeDrafts": True or False, # Set to true to exclude drafts.
- },
- "timeZone": "A String", # The time zone name.
- # It should be an IANA TZ name, such as "America/Los_Angeles".
- # For more information, see
- # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
- # Zone</a>.
- "corpus": "A String", # The corpus to search.
- "method": "A String", # The search method to use. This field is similar to the search_method field
- # but is introduced to support shared drives. It supports all
- # search method types. In case the search_method is TEAM_DRIVE the response
- # of this field will be SHARED_DRIVE only.
+ "savedQueryId": "A String", # A unique identifier for the saved query.
+ "matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
+ "displayName": "A String", # Name of the saved query.
+ "createTime": "A String", # Output only. The server generated timestamp at which saved query was created.
+ "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query.
+ "corpus": "A String", # The corpus to search.
+ "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
+ "includeSharedDrives": True or False, # Set to true to include shared drive.
+ "versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
+ "includeTeamDrives": True or False, # Set to true to include Team Drive.
},
- "displayName": "A String", # Name of the saved query.
- "matterId": "A String", # Output only. The matter ID of the associated matter.
- # The server does not look at this field during create and always uses matter
- # id in the URL.
- }
+ "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
+ "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
+ "roomId": [ # A set of rooms to search.
+ "A String",
+ ],
+ },
+ "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
+ "includeRooms": True or False, # Set to true to include rooms.
+ },
+ "terms": "A String", # The corpus-specific search operators used to generate search results.
+ "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
+ "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "searchMethod": "A String", # The search method to use.
+ "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
+ "emails": [ # A set of accounts to search.
+ "A String",
+ ],
+ },
+ "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
+ "excludeDrafts": True or False, # Set to true to exclude drafts.
+ },
+ "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
+ "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
+ "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
+ "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.
+ },
+ "dataScope": "A String", # The data source to search from.
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -186,81 +167,55 @@
An object of the form:
{ # Definition of the saved query.
- "createTime": "A String", # Output only. The server generated timestamp at which saved query was
- # created.
- "savedQueryId": "A String", # A unique identifier for the saved query.
- "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
- # query.
- "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
- # account_info needs to be specified.
- "emails": [ # A set of accounts to search.
- "A String",
- ],
- },
- "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
- # specified. (read-only)
- "roomId": [ # A set of rooms to search.
- "A String",
- ],
- },
- "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
- # specified.
- "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "dataScope": "A String", # The data source to search from.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "searchMethod": "A String", # The search method to use.
- "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
- "includeTeamDrives": True or False, # Set to true to include Team Drive.
- "includeSharedDrives": True or False, # Set to true to include shared drive.
- "versionDate": "A String", # Search the versions of the Drive file
- # as of the reference date. These timestamps are in GMT and
- # rounded down to the given date.
- },
- "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
- # to be specified.
- "orgUnitId": "A String", # Org unit to search, as provided by the
- # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
- # Directory API</a>.
- },
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "terms": "A String", # The corpus-specific
- # <a href="https://support.google.com/vault/answer/2474474">search
- # operators</a> used to generate search results.
- "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
- "includeRooms": True or False, # Set to true to include rooms.
- },
- "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
- # to be specified.
- "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
- "excludeDrafts": True or False, # Set to true to exclude drafts.
- },
- "timeZone": "A String", # The time zone name.
- # It should be an IANA TZ name, such as "America/Los_Angeles".
- # For more information, see
- # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
- # Zone</a>.
- "corpus": "A String", # The corpus to search.
- "method": "A String", # The search method to use. This field is similar to the search_method field
- # but is introduced to support shared drives. It supports all
- # search method types. In case the search_method is TEAM_DRIVE the response
- # of this field will be SHARED_DRIVE only.
+ "savedQueryId": "A String", # A unique identifier for the saved query.
+ "matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
+ "displayName": "A String", # Name of the saved query.
+ "createTime": "A String", # Output only. The server generated timestamp at which saved query was created.
+ "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query.
+ "corpus": "A String", # The corpus to search.
+ "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
+ "includeSharedDrives": True or False, # Set to true to include shared drive.
+ "versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
+ "includeTeamDrives": True or False, # Set to true to include Team Drive.
},
- "displayName": "A String", # Name of the saved query.
- "matterId": "A String", # Output only. The matter ID of the associated matter.
- # The server does not look at this field during create and always uses matter
- # id in the URL.
- }</pre>
+ "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
+ "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
+ "roomId": [ # A set of rooms to search.
+ "A String",
+ ],
+ },
+ "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
+ "includeRooms": True or False, # Set to true to include rooms.
+ },
+ "terms": "A String", # The corpus-specific search operators used to generate search results.
+ "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
+ "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "searchMethod": "A String", # The search method to use.
+ "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
+ "emails": [ # A set of accounts to search.
+ "A String",
+ ],
+ },
+ "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
+ "excludeDrafts": True or False, # Set to true to exclude drafts.
+ },
+ "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
+ "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
+ "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
+ "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.
+ },
+ "dataScope": "A String", # The data source to search from.
+ },
+ }</pre>
</div>
<div class="method">
@@ -268,8 +223,7 @@
<pre>Deletes a saved query by Id.
Args:
- matterId: string, The matter ID of the parent matter for which the saved query is to be
-deleted. (required)
+ matterId: string, The matter ID of the parent matter for which the saved query is to be deleted. (required)
savedQueryId: string, ID of the saved query to be deleted. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -279,15 +233,7 @@
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 `{}`.
+ { # 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>
@@ -296,8 +242,7 @@
<pre>Retrieves a saved query by Id.
Args:
- matterId: string, The matter ID of the parent matter for which the saved query is to be
-retrieved. (required)
+ matterId: string, The matter ID of the parent matter for which the saved query is to be retrieved. (required)
savedQueryId: string, ID of the saved query to be retrieved. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -308,94 +253,65 @@
An object of the form:
{ # Definition of the saved query.
- "createTime": "A String", # Output only. The server generated timestamp at which saved query was
- # created.
- "savedQueryId": "A String", # A unique identifier for the saved query.
- "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
- # query.
- "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
- # account_info needs to be specified.
- "emails": [ # A set of accounts to search.
- "A String",
- ],
- },
- "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
- # specified. (read-only)
- "roomId": [ # A set of rooms to search.
- "A String",
- ],
- },
- "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
- # specified.
- "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "dataScope": "A String", # The data source to search from.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "searchMethod": "A String", # The search method to use.
- "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
- "includeTeamDrives": True or False, # Set to true to include Team Drive.
- "includeSharedDrives": True or False, # Set to true to include shared drive.
- "versionDate": "A String", # Search the versions of the Drive file
- # as of the reference date. These timestamps are in GMT and
- # rounded down to the given date.
- },
- "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
- # to be specified.
- "orgUnitId": "A String", # Org unit to search, as provided by the
- # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
- # Directory API</a>.
- },
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "terms": "A String", # The corpus-specific
- # <a href="https://support.google.com/vault/answer/2474474">search
- # operators</a> used to generate search results.
- "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
- "includeRooms": True or False, # Set to true to include rooms.
- },
- "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
- # to be specified.
- "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
- "excludeDrafts": True or False, # Set to true to exclude drafts.
- },
- "timeZone": "A String", # The time zone name.
- # It should be an IANA TZ name, such as "America/Los_Angeles".
- # For more information, see
- # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
- # Zone</a>.
- "corpus": "A String", # The corpus to search.
- "method": "A String", # The search method to use. This field is similar to the search_method field
- # but is introduced to support shared drives. It supports all
- # search method types. In case the search_method is TEAM_DRIVE the response
- # of this field will be SHARED_DRIVE only.
+ "savedQueryId": "A String", # A unique identifier for the saved query.
+ "matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
+ "displayName": "A String", # Name of the saved query.
+ "createTime": "A String", # Output only. The server generated timestamp at which saved query was created.
+ "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query.
+ "corpus": "A String", # The corpus to search.
+ "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
+ "includeSharedDrives": True or False, # Set to true to include shared drive.
+ "versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
+ "includeTeamDrives": True or False, # Set to true to include Team Drive.
},
- "displayName": "A String", # Name of the saved query.
- "matterId": "A String", # Output only. The matter ID of the associated matter.
- # The server does not look at this field during create and always uses matter
- # id in the URL.
- }</pre>
+ "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
+ "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
+ "roomId": [ # A set of rooms to search.
+ "A String",
+ ],
+ },
+ "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
+ "includeRooms": True or False, # Set to true to include rooms.
+ },
+ "terms": "A String", # The corpus-specific search operators used to generate search results.
+ "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
+ "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "searchMethod": "A String", # The search method to use.
+ "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
+ "emails": [ # A set of accounts to search.
+ "A String",
+ ],
+ },
+ "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
+ "excludeDrafts": True or False, # Set to true to exclude drafts.
+ },
+ "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
+ "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
+ "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
+ "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.
+ },
+ "dataScope": "A String", # The data source to search from.
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(matterId, pageToken=None, pageSize=None, x__xgafv=None)</code>
- <pre>Lists saved queries within a matter. An empty page token in
-ListSavedQueriesResponse denotes no more saved queries to list.
+ <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.
Args:
- matterId: string, The matter ID of the parent matter for which the saved queries are to be
-retrieved. (required)
- pageToken: string, The pagination token as returned in the previous response.
-An empty token means start from the beginning.
+ matterId: string, The matter ID of the parent matter for which the saved queries are to be retrieved. (required)
pageSize: integer, The maximum number of saved queries to return.
+ pageToken: string, The pagination token as returned in the previous response. An empty token means start from the beginning.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -405,86 +321,59 @@
An object of the form:
{ # Definition of the response for method ListSaveQuery.
+ "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list.
"savedQueries": [ # List of output saved queries.
{ # Definition of the saved query.
- "createTime": "A String", # Output only. The server generated timestamp at which saved query was
- # created.
- "savedQueryId": "A String", # A unique identifier for the saved query.
- "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
- # query.
- "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
- # account_info needs to be specified.
- "emails": [ # A set of accounts to search.
- "A String",
- ],
- },
- "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
- # specified. (read-only)
- "roomId": [ # A set of rooms to search.
- "A String",
- ],
- },
- "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
- # specified.
- "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "dataScope": "A String", # The data source to search from.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "searchMethod": "A String", # The search method to use.
- "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
- "includeTeamDrives": True or False, # Set to true to include Team Drive.
- "includeSharedDrives": True or False, # Set to true to include shared drive.
- "versionDate": "A String", # Search the versions of the Drive file
- # as of the reference date. These timestamps are in GMT and
- # rounded down to the given date.
- },
- "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
- # to be specified.
- "orgUnitId": "A String", # Org unit to search, as provided by the
- # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
- # Directory API</a>.
- },
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
- # rounded down to the start of the given date.
- "terms": "A String", # The corpus-specific
- # <a href="https://support.google.com/vault/answer/2474474">search
- # operators</a> used to generate search results.
- "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
- "includeRooms": True or False, # Set to true to include rooms.
- },
- "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
- # to be specified.
- "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
- # href="https://developers.google.com/drive">Drive API</a>.
- "A String",
- ],
- },
- "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
- "excludeDrafts": True or False, # Set to true to exclude drafts.
- },
- "timeZone": "A String", # The time zone name.
- # It should be an IANA TZ name, such as "America/Los_Angeles".
- # For more information, see
- # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
- # Zone</a>.
- "corpus": "A String", # The corpus to search.
- "method": "A String", # The search method to use. This field is similar to the search_method field
- # but is introduced to support shared drives. It supports all
- # search method types. In case the search_method is TEAM_DRIVE the response
- # of this field will be SHARED_DRIVE only.
+ "savedQueryId": "A String", # A unique identifier for the saved query.
+ "matterId": "A String", # Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
+ "displayName": "A String", # Name of the saved query.
+ "createTime": "A String", # Output only. The server generated timestamp at which saved query was created.
+ "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query.
+ "corpus": "A String", # The corpus to search.
+ "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
+ "includeSharedDrives": True or False, # Set to true to include shared drive.
+ "versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
+ "includeTeamDrives": True or False, # Set to true to include Team Drive.
},
- "displayName": "A String", # Name of the saved query.
- "matterId": "A String", # Output only. The matter ID of the associated matter.
- # The server does not look at this field during create and always uses matter
- # id in the URL.
+ "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
+ "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
+ "roomId": [ # A set of rooms to search.
+ "A String",
+ ],
+ },
+ "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
+ "includeRooms": True or False, # Set to true to include rooms.
+ },
+ "terms": "A String", # The corpus-specific search operators used to generate search results.
+ "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
+ "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "searchMethod": "A String", # The search method to use.
+ "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
+ "emails": [ # A set of accounts to search.
+ "A String",
+ ],
+ },
+ "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
+ "excludeDrafts": True or False, # Set to true to exclude drafts.
+ },
+ "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
+ "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
+ "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.
+ "A String",
+ ],
+ },
+ "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
+ "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
+ "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.
+ },
+ "dataScope": "A String", # The data source to search from.
},
+ },
],
- "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
- # If this is empty, then there are no more saved queries to list.
}</pre>
</div>