| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <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> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a saved query.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(matterId, savedQueryId, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a saved query by Id.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(matterId, savedQueryId, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Retrieves a saved query by Id.</p> |
| 89 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <pre>Creates a saved query. |
| 104 | |
| 105 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | matterId: string, The matter ID of the parent matter for which the saved query is to be created. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 108 | The object takes the form of: |
| 109 | |
| 110 | { # Definition of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 111 | "createTime": "A String", # Output only. The server generated timestamp at which saved query was created. |
| 112 | "displayName": "A String", # Name of the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 113 | "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 114 | "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. |
| 115 | "dataScope": "A String", # The data source to search from. |
| 116 | "corpus": "A String", # The corpus to search. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 117 | "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) |
| 118 | "roomId": [ # A set of rooms to search. |
| 119 | "A String", |
| 120 | ], |
| 121 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 122 | "searchMethod": "A String", # The search method to use. |
| 123 | "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. |
| 124 | "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. |
| 125 | "terms": "A String", # The corpus-specific search operators used to generate search results. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 126 | "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. |
| 127 | "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API. |
| 128 | "A String", |
| 129 | ], |
| 130 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 131 | "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field. |
| 132 | "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. |
| 133 | "includeTeamDrives": True or False, # Set to true to include Team Drive. |
| 134 | "includeSharedDrives": True or False, # Set to true to include shared drive. |
| 135 | }, |
| 136 | "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field. |
| 137 | "excludeDrafts": True or False, # Set to true to exclude drafts. |
| 138 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 139 | "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only) |
| 140 | "includeRooms": True or False, # Set to true to include rooms. |
| 141 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 142 | "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. |
| 143 | "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API. |
| 144 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 145 | "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified. |
| 146 | "emails": [ # A set of accounts to search. |
| 147 | "A String", |
| 148 | ], |
| 149 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 150 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 151 | "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. |
| 152 | "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API. |
| 153 | "A String", |
| 154 | ], |
| 155 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 157 | "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. |
| 158 | "savedQueryId": "A String", # A unique identifier for the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 159 | } |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 160 | |
| 161 | x__xgafv: string, V1 error format. |
| 162 | Allowed values |
| 163 | 1 - v1 error format |
| 164 | 2 - v2 error format |
| 165 | |
| 166 | Returns: |
| 167 | An object of the form: |
| 168 | |
| 169 | { # Definition of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 170 | "createTime": "A String", # Output only. The server generated timestamp at which saved query was created. |
| 171 | "displayName": "A String", # Name of the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 172 | "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 173 | "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. |
| 174 | "dataScope": "A String", # The data source to search from. |
| 175 | "corpus": "A String", # The corpus to search. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 176 | "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) |
| 177 | "roomId": [ # A set of rooms to search. |
| 178 | "A String", |
| 179 | ], |
| 180 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 181 | "searchMethod": "A String", # The search method to use. |
| 182 | "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. |
| 183 | "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. |
| 184 | "terms": "A String", # The corpus-specific search operators used to generate search results. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 185 | "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. |
| 186 | "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API. |
| 187 | "A String", |
| 188 | ], |
| 189 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 190 | "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field. |
| 191 | "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. |
| 192 | "includeTeamDrives": True or False, # Set to true to include Team Drive. |
| 193 | "includeSharedDrives": True or False, # Set to true to include shared drive. |
| 194 | }, |
| 195 | "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field. |
| 196 | "excludeDrafts": True or False, # Set to true to exclude drafts. |
| 197 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 198 | "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only) |
| 199 | "includeRooms": True or False, # Set to true to include rooms. |
| 200 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 201 | "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. |
| 202 | "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API. |
| 203 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 204 | "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified. |
| 205 | "emails": [ # A set of accounts to search. |
| 206 | "A String", |
| 207 | ], |
| 208 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 209 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 210 | "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. |
| 211 | "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API. |
| 212 | "A String", |
| 213 | ], |
| 214 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 215 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 216 | "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. |
| 217 | "savedQueryId": "A String", # A unique identifier for the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 218 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | </div> |
| 220 | |
| 221 | <div class="method"> |
| 222 | <code class="details" id="delete">delete(matterId, savedQueryId, x__xgafv=None)</code> |
| 223 | <pre>Deletes a saved query by Id. |
| 224 | |
| 225 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 226 | matterId: string, The matter ID of the parent matter for which the saved query is to be deleted. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 227 | savedQueryId: string, ID of the saved query to be deleted. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 228 | x__xgafv: string, V1 error format. |
| 229 | Allowed values |
| 230 | 1 - v1 error format |
| 231 | 2 - v2 error format |
| 232 | |
| 233 | Returns: |
| 234 | An object of the form: |
| 235 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 236 | { # 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 `{}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 237 | }</pre> |
| 238 | </div> |
| 239 | |
| 240 | <div class="method"> |
| 241 | <code class="details" id="get">get(matterId, savedQueryId, x__xgafv=None)</code> |
| 242 | <pre>Retrieves a saved query by Id. |
| 243 | |
| 244 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 245 | matterId: string, The matter ID of the parent matter for which the saved query is to be retrieved. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 246 | savedQueryId: string, ID of the saved query to be retrieved. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 247 | x__xgafv: string, V1 error format. |
| 248 | Allowed values |
| 249 | 1 - v1 error format |
| 250 | 2 - v2 error format |
| 251 | |
| 252 | Returns: |
| 253 | An object of the form: |
| 254 | |
| 255 | { # Definition of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 256 | "createTime": "A String", # Output only. The server generated timestamp at which saved query was created. |
| 257 | "displayName": "A String", # Name of the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 258 | "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 259 | "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. |
| 260 | "dataScope": "A String", # The data source to search from. |
| 261 | "corpus": "A String", # The corpus to search. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 262 | "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) |
| 263 | "roomId": [ # A set of rooms to search. |
| 264 | "A String", |
| 265 | ], |
| 266 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 267 | "searchMethod": "A String", # The search method to use. |
| 268 | "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. |
| 269 | "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. |
| 270 | "terms": "A String", # The corpus-specific search operators used to generate search results. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 271 | "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. |
| 272 | "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API. |
| 273 | "A String", |
| 274 | ], |
| 275 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 276 | "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field. |
| 277 | "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. |
| 278 | "includeTeamDrives": True or False, # Set to true to include Team Drive. |
| 279 | "includeSharedDrives": True or False, # Set to true to include shared drive. |
| 280 | }, |
| 281 | "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field. |
| 282 | "excludeDrafts": True or False, # Set to true to exclude drafts. |
| 283 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 284 | "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only) |
| 285 | "includeRooms": True or False, # Set to true to include rooms. |
| 286 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 287 | "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. |
| 288 | "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API. |
| 289 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 290 | "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified. |
| 291 | "emails": [ # A set of accounts to search. |
| 292 | "A String", |
| 293 | ], |
| 294 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 295 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 296 | "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. |
| 297 | "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API. |
| 298 | "A String", |
| 299 | ], |
| 300 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 301 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 302 | "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. |
| 303 | "savedQueryId": "A String", # A unique identifier for the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 304 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 305 | </div> |
| 306 | |
| 307 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 308 | <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 309 | <pre>Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 310 | |
| 311 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 312 | matterId: string, The matter ID of the parent matter for which the saved queries are to be retrieved. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | pageSize: integer, The maximum number of saved queries to return. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 314 | pageToken: string, The pagination token as returned in the previous response. An empty token means start from the beginning. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 315 | x__xgafv: string, V1 error format. |
| 316 | Allowed values |
| 317 | 1 - v1 error format |
| 318 | 2 - v2 error format |
| 319 | |
| 320 | Returns: |
| 321 | An object of the form: |
| 322 | |
| 323 | { # Definition of the response for method ListSaveQuery. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 324 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 325 | "savedQueries": [ # List of output saved queries. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 326 | { # Definition of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 327 | "createTime": "A String", # Output only. The server generated timestamp at which saved query was created. |
| 328 | "displayName": "A String", # Name of the saved query. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 329 | "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved query. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 330 | "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. |
| 331 | "dataScope": "A String", # The data source to search from. |
| 332 | "corpus": "A String", # The corpus to search. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 333 | "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) |
| 334 | "roomId": [ # A set of rooms to search. |
| 335 | "A String", |
| 336 | ], |
| 337 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 338 | "searchMethod": "A String", # The search method to use. |
| 339 | "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. |
| 340 | "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. |
| 341 | "terms": "A String", # The corpus-specific search operators used to generate search results. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 342 | "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. |
| 343 | "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API. |
| 344 | "A String", |
| 345 | ], |
| 346 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 347 | "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field. |
| 348 | "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. |
| 349 | "includeTeamDrives": True or False, # Set to true to include Team Drive. |
| 350 | "includeSharedDrives": True or False, # Set to true to include shared drive. |
| 351 | }, |
| 352 | "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field. |
| 353 | "excludeDrafts": True or False, # Set to true to exclude drafts. |
| 354 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 355 | "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only) |
| 356 | "includeRooms": True or False, # Set to true to include rooms. |
| 357 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 358 | "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. |
| 359 | "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API. |
| 360 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 361 | "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified. |
| 362 | "emails": [ # A set of accounts to search. |
| 363 | "A String", |
| 364 | ], |
| 365 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 366 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 367 | "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. |
| 368 | "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API. |
| 369 | "A String", |
| 370 | ], |
| 371 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 372 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 373 | "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. |
| 374 | "savedQueryId": "A String", # A unique identifier for the saved query. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | }, |
| 376 | ], |
| 377 | }</pre> |
| 378 | </div> |
| 379 | |
| 380 | <div class="method"> |
| 381 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 382 | <pre>Retrieves the next page of results. |
| 383 | |
| 384 | Args: |
| 385 | previous_request: The request for the previous page. (required) |
| 386 | previous_response: The response from the request for the previous page. (required) |
| 387 | |
| 388 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 389 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | page. Returns None if there are no more items in the collection. |
| 391 | </pre> |
| 392 | </div> |
| 393 | |
| 394 | </body></html> |