Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1 | { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2 | "auth": { |
| 3 | "oauth2": { |
| 4 | "scopes": { |
| 5 | "https://www.googleapis.com/auth/ediscovery": { |
| 6 | "description": "Manage your eDiscovery data" |
| 7 | }, |
| 8 | "https://www.googleapis.com/auth/ediscovery.readonly": { |
| 9 | "description": "View your eDiscovery data" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 10 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 11 | } |
| 12 | } |
| 13 | }, |
| 14 | "basePath": "", |
| 15 | "baseUrl": "https://vault.googleapis.com/", |
| 16 | "batchPath": "batch", |
| 17 | "canonicalName": "Vault", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 18 | "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 19 | "discoveryVersion": "v1", |
| 20 | "documentationLink": "https://developers.google.com/vault", |
| 21 | "fullyEncodeReservedExpansion": true, |
| 22 | "icons": { |
| 23 | "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 24 | "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 25 | }, |
| 26 | "id": "vault:v1", |
| 27 | "kind": "discovery#restDescription", |
| 28 | "mtlsRootUrl": "https://vault.mtls.googleapis.com/", |
| 29 | "name": "vault", |
| 30 | "ownerDomain": "google.com", |
| 31 | "ownerName": "Google", |
| 32 | "parameters": { |
| 33 | "$.xgafv": { |
| 34 | "description": "V1 error format.", |
| 35 | "enum": [ |
| 36 | "1", |
| 37 | "2" |
| 38 | ], |
| 39 | "enumDescriptions": [ |
| 40 | "v1 error format", |
| 41 | "v2 error format" |
| 42 | ], |
| 43 | "location": "query", |
| 44 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 45 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 46 | "access_token": { |
| 47 | "description": "OAuth access token.", |
| 48 | "location": "query", |
| 49 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 50 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 51 | "alt": { |
| 52 | "default": "json", |
| 53 | "description": "Data format for response.", |
| 54 | "enum": [ |
| 55 | "json", |
| 56 | "media", |
| 57 | "proto" |
| 58 | ], |
| 59 | "enumDescriptions": [ |
| 60 | "Responses with Content-Type of application/json", |
| 61 | "Media download with context-dependent Content-Type", |
| 62 | "Responses with Content-Type of application/x-protobuf" |
| 63 | ], |
| 64 | "location": "query", |
| 65 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 66 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 67 | "callback": { |
| 68 | "description": "JSONP", |
| 69 | "location": "query", |
| 70 | "type": "string" |
| 71 | }, |
| 72 | "fields": { |
| 73 | "description": "Selector specifying which fields to include in a partial response.", |
| 74 | "location": "query", |
| 75 | "type": "string" |
| 76 | }, |
| 77 | "key": { |
| 78 | "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| 79 | "location": "query", |
| 80 | "type": "string" |
| 81 | }, |
| 82 | "oauth_token": { |
| 83 | "description": "OAuth 2.0 token for the current user.", |
| 84 | "location": "query", |
| 85 | "type": "string" |
| 86 | }, |
| 87 | "prettyPrint": { |
| 88 | "default": "true", |
| 89 | "description": "Returns response with indentations and line breaks.", |
| 90 | "location": "query", |
| 91 | "type": "boolean" |
| 92 | }, |
| 93 | "quotaUser": { |
| 94 | "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| 95 | "location": "query", |
| 96 | "type": "string" |
| 97 | }, |
| 98 | "uploadType": { |
| 99 | "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| 100 | "location": "query", |
| 101 | "type": "string" |
| 102 | }, |
| 103 | "upload_protocol": { |
| 104 | "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| 105 | "location": "query", |
| 106 | "type": "string" |
| 107 | } |
| 108 | }, |
| 109 | "protocol": "rest", |
| 110 | "resources": { |
| 111 | "matters": { |
| 112 | "methods": { |
| 113 | "addPermissions": { |
| 114 | "description": "Adds an account as a matter collaborator.", |
| 115 | "flatPath": "v1/matters/{matterId}:addPermissions", |
| 116 | "httpMethod": "POST", |
| 117 | "id": "vault.matters.addPermissions", |
| 118 | "parameterOrder": [ |
| 119 | "matterId" |
| 120 | ], |
| 121 | "parameters": { |
| 122 | "matterId": { |
| 123 | "description": "The matter ID.", |
| 124 | "location": "path", |
| 125 | "required": true, |
| 126 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 127 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 128 | }, |
| 129 | "path": "v1/matters/{matterId}:addPermissions", |
| 130 | "request": { |
| 131 | "$ref": "AddMatterPermissionsRequest" |
| 132 | }, |
| 133 | "response": { |
| 134 | "$ref": "MatterPermission" |
| 135 | }, |
| 136 | "scopes": [ |
| 137 | "https://www.googleapis.com/auth/ediscovery" |
| 138 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 139 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 140 | "close": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 141 | "description": "Closes the specified matter. Returns the matter with updated state.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 142 | "flatPath": "v1/matters/{matterId}:close", |
| 143 | "httpMethod": "POST", |
| 144 | "id": "vault.matters.close", |
| 145 | "parameterOrder": [ |
| 146 | "matterId" |
| 147 | ], |
| 148 | "parameters": { |
| 149 | "matterId": { |
| 150 | "description": "The matter ID.", |
| 151 | "location": "path", |
| 152 | "required": true, |
| 153 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 154 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 155 | }, |
| 156 | "path": "v1/matters/{matterId}:close", |
| 157 | "request": { |
| 158 | "$ref": "CloseMatterRequest" |
| 159 | }, |
| 160 | "response": { |
| 161 | "$ref": "CloseMatterResponse" |
| 162 | }, |
| 163 | "scopes": [ |
| 164 | "https://www.googleapis.com/auth/ediscovery" |
| 165 | ] |
| 166 | }, |
| 167 | "count": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 168 | "description": "Counts the accounts processed by the specified query.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 169 | "flatPath": "v1/matters/{matterId}:count", |
| 170 | "httpMethod": "POST", |
| 171 | "id": "vault.matters.count", |
| 172 | "parameterOrder": [ |
| 173 | "matterId" |
| 174 | ], |
| 175 | "parameters": { |
| 176 | "matterId": { |
| 177 | "description": "The matter ID.", |
| 178 | "location": "path", |
| 179 | "required": true, |
| 180 | "type": "string" |
| 181 | } |
| 182 | }, |
| 183 | "path": "v1/matters/{matterId}:count", |
| 184 | "request": { |
| 185 | "$ref": "CountArtifactsRequest" |
| 186 | }, |
| 187 | "response": { |
| 188 | "$ref": "Operation" |
| 189 | }, |
| 190 | "scopes": [ |
| 191 | "https://www.googleapis.com/auth/ediscovery" |
| 192 | ] |
| 193 | }, |
| 194 | "create": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 195 | "description": "Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 196 | "flatPath": "v1/matters", |
| 197 | "httpMethod": "POST", |
| 198 | "id": "vault.matters.create", |
| 199 | "parameterOrder": [], |
| 200 | "parameters": {}, |
| 201 | "path": "v1/matters", |
| 202 | "request": { |
| 203 | "$ref": "Matter" |
| 204 | }, |
| 205 | "response": { |
| 206 | "$ref": "Matter" |
| 207 | }, |
| 208 | "scopes": [ |
| 209 | "https://www.googleapis.com/auth/ediscovery" |
| 210 | ] |
| 211 | }, |
| 212 | "delete": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 213 | "description": "Deletes the specified matter. Returns the matter with updated state.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 214 | "flatPath": "v1/matters/{matterId}", |
| 215 | "httpMethod": "DELETE", |
| 216 | "id": "vault.matters.delete", |
| 217 | "parameterOrder": [ |
| 218 | "matterId" |
| 219 | ], |
| 220 | "parameters": { |
| 221 | "matterId": { |
| 222 | "description": "The matter ID", |
| 223 | "location": "path", |
| 224 | "required": true, |
| 225 | "type": "string" |
| 226 | } |
| 227 | }, |
| 228 | "path": "v1/matters/{matterId}", |
| 229 | "response": { |
| 230 | "$ref": "Matter" |
| 231 | }, |
| 232 | "scopes": [ |
| 233 | "https://www.googleapis.com/auth/ediscovery" |
| 234 | ] |
| 235 | }, |
| 236 | "get": { |
| 237 | "description": "Gets the specified matter.", |
| 238 | "flatPath": "v1/matters/{matterId}", |
| 239 | "httpMethod": "GET", |
| 240 | "id": "vault.matters.get", |
| 241 | "parameterOrder": [ |
| 242 | "matterId" |
| 243 | ], |
| 244 | "parameters": { |
| 245 | "matterId": { |
| 246 | "description": "The matter ID.", |
| 247 | "location": "path", |
| 248 | "required": true, |
| 249 | "type": "string" |
| 250 | }, |
| 251 | "view": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 252 | "description": "Specifies how much information about the matter to return in the response.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 253 | "enum": [ |
| 254 | "VIEW_UNSPECIFIED", |
| 255 | "BASIC", |
| 256 | "FULL" |
| 257 | ], |
| 258 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 259 | "The amount of detail is unspecified. Same as **BASIC**.", |
| 260 | "Returns the matter ID, name, description, and state. Default choice.", |
| 261 | "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission))." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 262 | ], |
| 263 | "location": "query", |
| 264 | "type": "string" |
| 265 | } |
| 266 | }, |
| 267 | "path": "v1/matters/{matterId}", |
| 268 | "response": { |
| 269 | "$ref": "Matter" |
| 270 | }, |
| 271 | "scopes": [ |
| 272 | "https://www.googleapis.com/auth/ediscovery", |
| 273 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 274 | ] |
| 275 | }, |
| 276 | "list": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 277 | "description": "Lists matters the requestor has access to.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 278 | "flatPath": "v1/matters", |
| 279 | "httpMethod": "GET", |
| 280 | "id": "vault.matters.list", |
| 281 | "parameterOrder": [], |
| 282 | "parameters": { |
| 283 | "pageSize": { |
| 284 | "description": "The number of matters to return in the response. Default and maximum are 100.", |
| 285 | "format": "int32", |
| 286 | "location": "query", |
| 287 | "type": "integer" |
| 288 | }, |
| 289 | "pageToken": { |
| 290 | "description": "The pagination token as returned in the response.", |
| 291 | "location": "query", |
| 292 | "type": "string" |
| 293 | }, |
| 294 | "state": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 295 | "description": "If set, lists only matters with the specified state. The default lists matters of all states.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 296 | "enum": [ |
| 297 | "STATE_UNSPECIFIED", |
| 298 | "OPEN", |
| 299 | "CLOSED", |
| 300 | "DELETED" |
| 301 | ], |
| 302 | "enumDescriptions": [ |
| 303 | "The matter has no specified state.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 304 | "The matter is open.", |
| 305 | "The matter is closed.", |
| 306 | "The matter is deleted." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 307 | ], |
| 308 | "location": "query", |
| 309 | "type": "string" |
| 310 | }, |
| 311 | "view": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 312 | "description": "Specifies how much information about the matter to return in response.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 313 | "enum": [ |
| 314 | "VIEW_UNSPECIFIED", |
| 315 | "BASIC", |
| 316 | "FULL" |
| 317 | ], |
| 318 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 319 | "The amount of detail is unspecified. Same as **BASIC**.", |
| 320 | "Returns the matter ID, name, description, and state. Default choice.", |
| 321 | "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission))." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 322 | ], |
| 323 | "location": "query", |
| 324 | "type": "string" |
| 325 | } |
| 326 | }, |
| 327 | "path": "v1/matters", |
| 328 | "response": { |
| 329 | "$ref": "ListMattersResponse" |
| 330 | }, |
| 331 | "scopes": [ |
| 332 | "https://www.googleapis.com/auth/ediscovery", |
| 333 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 334 | ] |
| 335 | }, |
| 336 | "removePermissions": { |
| 337 | "description": "Removes an account as a matter collaborator.", |
| 338 | "flatPath": "v1/matters/{matterId}:removePermissions", |
| 339 | "httpMethod": "POST", |
| 340 | "id": "vault.matters.removePermissions", |
| 341 | "parameterOrder": [ |
| 342 | "matterId" |
| 343 | ], |
| 344 | "parameters": { |
| 345 | "matterId": { |
| 346 | "description": "The matter ID.", |
| 347 | "location": "path", |
| 348 | "required": true, |
| 349 | "type": "string" |
| 350 | } |
| 351 | }, |
| 352 | "path": "v1/matters/{matterId}:removePermissions", |
| 353 | "request": { |
| 354 | "$ref": "RemoveMatterPermissionsRequest" |
| 355 | }, |
| 356 | "response": { |
| 357 | "$ref": "Empty" |
| 358 | }, |
| 359 | "scopes": [ |
| 360 | "https://www.googleapis.com/auth/ediscovery" |
| 361 | ] |
| 362 | }, |
| 363 | "reopen": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 364 | "description": "Reopens the specified matter. Returns the matter with updated state.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 365 | "flatPath": "v1/matters/{matterId}:reopen", |
| 366 | "httpMethod": "POST", |
| 367 | "id": "vault.matters.reopen", |
| 368 | "parameterOrder": [ |
| 369 | "matterId" |
| 370 | ], |
| 371 | "parameters": { |
| 372 | "matterId": { |
| 373 | "description": "The matter ID.", |
| 374 | "location": "path", |
| 375 | "required": true, |
| 376 | "type": "string" |
| 377 | } |
| 378 | }, |
| 379 | "path": "v1/matters/{matterId}:reopen", |
| 380 | "request": { |
| 381 | "$ref": "ReopenMatterRequest" |
| 382 | }, |
| 383 | "response": { |
| 384 | "$ref": "ReopenMatterResponse" |
| 385 | }, |
| 386 | "scopes": [ |
| 387 | "https://www.googleapis.com/auth/ediscovery" |
| 388 | ] |
| 389 | }, |
| 390 | "undelete": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 391 | "description": "Undeletes the specified matter. Returns the matter with updated state.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 392 | "flatPath": "v1/matters/{matterId}:undelete", |
| 393 | "httpMethod": "POST", |
| 394 | "id": "vault.matters.undelete", |
| 395 | "parameterOrder": [ |
| 396 | "matterId" |
| 397 | ], |
| 398 | "parameters": { |
| 399 | "matterId": { |
| 400 | "description": "The matter ID.", |
| 401 | "location": "path", |
| 402 | "required": true, |
| 403 | "type": "string" |
| 404 | } |
| 405 | }, |
| 406 | "path": "v1/matters/{matterId}:undelete", |
| 407 | "request": { |
| 408 | "$ref": "UndeleteMatterRequest" |
| 409 | }, |
| 410 | "response": { |
| 411 | "$ref": "Matter" |
| 412 | }, |
| 413 | "scopes": [ |
| 414 | "https://www.googleapis.com/auth/ediscovery" |
| 415 | ] |
| 416 | }, |
| 417 | "update": { |
| 418 | "description": "Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.", |
| 419 | "flatPath": "v1/matters/{matterId}", |
| 420 | "httpMethod": "PUT", |
| 421 | "id": "vault.matters.update", |
| 422 | "parameterOrder": [ |
| 423 | "matterId" |
| 424 | ], |
| 425 | "parameters": { |
| 426 | "matterId": { |
| 427 | "description": "The matter ID.", |
| 428 | "location": "path", |
| 429 | "required": true, |
| 430 | "type": "string" |
| 431 | } |
| 432 | }, |
| 433 | "path": "v1/matters/{matterId}", |
| 434 | "request": { |
| 435 | "$ref": "Matter" |
| 436 | }, |
| 437 | "response": { |
| 438 | "$ref": "Matter" |
| 439 | }, |
| 440 | "scopes": [ |
| 441 | "https://www.googleapis.com/auth/ediscovery" |
| 442 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 443 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 444 | }, |
| 445 | "resources": { |
| 446 | "exports": { |
| 447 | "methods": { |
| 448 | "create": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 449 | "description": "Creates an export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 450 | "flatPath": "v1/matters/{matterId}/exports", |
| 451 | "httpMethod": "POST", |
| 452 | "id": "vault.matters.exports.create", |
| 453 | "parameterOrder": [ |
| 454 | "matterId" |
| 455 | ], |
| 456 | "parameters": { |
| 457 | "matterId": { |
| 458 | "description": "The matter ID.", |
| 459 | "location": "path", |
| 460 | "required": true, |
| 461 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 462 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 463 | }, |
| 464 | "path": "v1/matters/{matterId}/exports", |
| 465 | "request": { |
| 466 | "$ref": "Export" |
| 467 | }, |
| 468 | "response": { |
| 469 | "$ref": "Export" |
| 470 | }, |
| 471 | "scopes": [ |
| 472 | "https://www.googleapis.com/auth/ediscovery" |
| 473 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 474 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 475 | "delete": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 476 | "description": "Deletes an export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 477 | "flatPath": "v1/matters/{matterId}/exports/{exportId}", |
| 478 | "httpMethod": "DELETE", |
| 479 | "id": "vault.matters.exports.delete", |
| 480 | "parameterOrder": [ |
| 481 | "matterId", |
| 482 | "exportId" |
| 483 | ], |
| 484 | "parameters": { |
| 485 | "exportId": { |
| 486 | "description": "The export ID.", |
| 487 | "location": "path", |
| 488 | "required": true, |
| 489 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 490 | }, |
| 491 | "matterId": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 492 | "description": "The matter ID.", |
| 493 | "location": "path", |
| 494 | "required": true, |
| 495 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 496 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 497 | }, |
| 498 | "path": "v1/matters/{matterId}/exports/{exportId}", |
| 499 | "response": { |
| 500 | "$ref": "Empty" |
| 501 | }, |
| 502 | "scopes": [ |
| 503 | "https://www.googleapis.com/auth/ediscovery" |
| 504 | ] |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 505 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 506 | "get": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 507 | "description": "Gets an export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 508 | "flatPath": "v1/matters/{matterId}/exports/{exportId}", |
| 509 | "httpMethod": "GET", |
| 510 | "id": "vault.matters.exports.get", |
| 511 | "parameterOrder": [ |
| 512 | "matterId", |
| 513 | "exportId" |
| 514 | ], |
| 515 | "parameters": { |
| 516 | "exportId": { |
| 517 | "description": "The export ID.", |
| 518 | "location": "path", |
| 519 | "required": true, |
| 520 | "type": "string" |
| 521 | }, |
| 522 | "matterId": { |
| 523 | "description": "The matter ID.", |
| 524 | "location": "path", |
| 525 | "required": true, |
| 526 | "type": "string" |
| 527 | } |
| 528 | }, |
| 529 | "path": "v1/matters/{matterId}/exports/{exportId}", |
| 530 | "response": { |
| 531 | "$ref": "Export" |
| 532 | }, |
| 533 | "scopes": [ |
| 534 | "https://www.googleapis.com/auth/ediscovery", |
| 535 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 536 | ] |
| 537 | }, |
| 538 | "list": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 539 | "description": "Lists details about the exports in the specified matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 540 | "flatPath": "v1/matters/{matterId}/exports", |
| 541 | "httpMethod": "GET", |
| 542 | "id": "vault.matters.exports.list", |
| 543 | "parameterOrder": [ |
| 544 | "matterId" |
| 545 | ], |
| 546 | "parameters": { |
| 547 | "matterId": { |
| 548 | "description": "The matter ID.", |
| 549 | "location": "path", |
| 550 | "required": true, |
| 551 | "type": "string" |
| 552 | }, |
| 553 | "pageSize": { |
| 554 | "description": "The number of exports to return in the response.", |
| 555 | "format": "int32", |
| 556 | "location": "query", |
| 557 | "type": "integer" |
| 558 | }, |
| 559 | "pageToken": { |
| 560 | "description": "The pagination token as returned in the response.", |
| 561 | "location": "query", |
| 562 | "type": "string" |
| 563 | } |
| 564 | }, |
| 565 | "path": "v1/matters/{matterId}/exports", |
| 566 | "response": { |
| 567 | "$ref": "ListExportsResponse" |
| 568 | }, |
| 569 | "scopes": [ |
| 570 | "https://www.googleapis.com/auth/ediscovery", |
| 571 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 572 | ] |
| 573 | } |
| 574 | } |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 575 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 576 | "holds": { |
| 577 | "methods": { |
| 578 | "addHeldAccounts": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 579 | "description": "Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 580 | "flatPath": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts", |
| 581 | "httpMethod": "POST", |
| 582 | "id": "vault.matters.holds.addHeldAccounts", |
| 583 | "parameterOrder": [ |
| 584 | "matterId", |
| 585 | "holdId" |
| 586 | ], |
| 587 | "parameters": { |
| 588 | "holdId": { |
| 589 | "description": "The hold ID.", |
| 590 | "location": "path", |
| 591 | "required": true, |
| 592 | "type": "string" |
| 593 | }, |
| 594 | "matterId": { |
| 595 | "description": "The matter ID.", |
| 596 | "location": "path", |
| 597 | "required": true, |
| 598 | "type": "string" |
| 599 | } |
| 600 | }, |
| 601 | "path": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts", |
| 602 | "request": { |
| 603 | "$ref": "AddHeldAccountsRequest" |
| 604 | }, |
| 605 | "response": { |
| 606 | "$ref": "AddHeldAccountsResponse" |
| 607 | }, |
| 608 | "scopes": [ |
| 609 | "https://www.googleapis.com/auth/ediscovery" |
| 610 | ] |
| 611 | }, |
| 612 | "create": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 613 | "description": "Creates a hold in the specified matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 614 | "flatPath": "v1/matters/{matterId}/holds", |
| 615 | "httpMethod": "POST", |
| 616 | "id": "vault.matters.holds.create", |
| 617 | "parameterOrder": [ |
| 618 | "matterId" |
| 619 | ], |
| 620 | "parameters": { |
| 621 | "matterId": { |
| 622 | "description": "The matter ID.", |
| 623 | "location": "path", |
| 624 | "required": true, |
| 625 | "type": "string" |
| 626 | } |
| 627 | }, |
| 628 | "path": "v1/matters/{matterId}/holds", |
| 629 | "request": { |
| 630 | "$ref": "Hold" |
| 631 | }, |
| 632 | "response": { |
| 633 | "$ref": "Hold" |
| 634 | }, |
| 635 | "scopes": [ |
| 636 | "https://www.googleapis.com/auth/ediscovery" |
| 637 | ] |
| 638 | }, |
| 639 | "delete": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 640 | "description": "Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 641 | "flatPath": "v1/matters/{matterId}/holds/{holdId}", |
| 642 | "httpMethod": "DELETE", |
| 643 | "id": "vault.matters.holds.delete", |
| 644 | "parameterOrder": [ |
| 645 | "matterId", |
| 646 | "holdId" |
| 647 | ], |
| 648 | "parameters": { |
| 649 | "holdId": { |
| 650 | "description": "The hold ID.", |
| 651 | "location": "path", |
| 652 | "required": true, |
| 653 | "type": "string" |
| 654 | }, |
| 655 | "matterId": { |
| 656 | "description": "The matter ID.", |
| 657 | "location": "path", |
| 658 | "required": true, |
| 659 | "type": "string" |
| 660 | } |
| 661 | }, |
| 662 | "path": "v1/matters/{matterId}/holds/{holdId}", |
| 663 | "response": { |
| 664 | "$ref": "Empty" |
| 665 | }, |
| 666 | "scopes": [ |
| 667 | "https://www.googleapis.com/auth/ediscovery" |
| 668 | ] |
| 669 | }, |
| 670 | "get": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 671 | "description": "Gets the specified hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 672 | "flatPath": "v1/matters/{matterId}/holds/{holdId}", |
| 673 | "httpMethod": "GET", |
| 674 | "id": "vault.matters.holds.get", |
| 675 | "parameterOrder": [ |
| 676 | "matterId", |
| 677 | "holdId" |
| 678 | ], |
| 679 | "parameters": { |
| 680 | "holdId": { |
| 681 | "description": "The hold ID.", |
| 682 | "location": "path", |
| 683 | "required": true, |
| 684 | "type": "string" |
| 685 | }, |
| 686 | "matterId": { |
| 687 | "description": "The matter ID.", |
| 688 | "location": "path", |
| 689 | "required": true, |
| 690 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 691 | }, |
| 692 | "view": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 693 | "description": "The amount of detail to return for a hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 694 | "enum": [ |
| 695 | "HOLD_VIEW_UNSPECIFIED", |
| 696 | "BASIC_HOLD", |
| 697 | "FULL_HOLD" |
| 698 | ], |
| 699 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 700 | "Not specified. Defaults to **FULL_HOLD**.", |
| 701 | "Returns the hold ID, name, update time, service, and query.", |
| 702 | "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 703 | ], |
| 704 | "location": "query", |
| 705 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 706 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 707 | }, |
| 708 | "path": "v1/matters/{matterId}/holds/{holdId}", |
| 709 | "response": { |
| 710 | "$ref": "Hold" |
| 711 | }, |
| 712 | "scopes": [ |
| 713 | "https://www.googleapis.com/auth/ediscovery", |
| 714 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 715 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 716 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 717 | "list": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 718 | "description": "Lists the holds in a matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 719 | "flatPath": "v1/matters/{matterId}/holds", |
| 720 | "httpMethod": "GET", |
| 721 | "id": "vault.matters.holds.list", |
| 722 | "parameterOrder": [ |
| 723 | "matterId" |
| 724 | ], |
| 725 | "parameters": { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 726 | "matterId": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 727 | "description": "The matter ID.", |
| 728 | "location": "path", |
| 729 | "required": true, |
| 730 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 731 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 732 | "pageSize": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 733 | "description": "The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 734 | "format": "int32", |
| 735 | "location": "query", |
| 736 | "type": "integer" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 737 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 738 | "pageToken": { |
| 739 | "description": "The pagination token as returned in the response. An empty token means start from the beginning.", |
| 740 | "location": "query", |
| 741 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 742 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 743 | "view": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 744 | "description": "The amount of detail to return for a hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 745 | "enum": [ |
| 746 | "HOLD_VIEW_UNSPECIFIED", |
| 747 | "BASIC_HOLD", |
| 748 | "FULL_HOLD" |
| 749 | ], |
| 750 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 751 | "Not specified. Defaults to **FULL_HOLD**.", |
| 752 | "Returns the hold ID, name, update time, service, and query.", |
| 753 | "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 754 | ], |
| 755 | "location": "query", |
| 756 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 757 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 758 | }, |
| 759 | "path": "v1/matters/{matterId}/holds", |
| 760 | "response": { |
| 761 | "$ref": "ListHoldsResponse" |
| 762 | }, |
| 763 | "scopes": [ |
| 764 | "https://www.googleapis.com/auth/ediscovery", |
| 765 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 766 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 767 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 768 | "removeHeldAccounts": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 769 | "description": "Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 770 | "flatPath": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts", |
| 771 | "httpMethod": "POST", |
| 772 | "id": "vault.matters.holds.removeHeldAccounts", |
| 773 | "parameterOrder": [ |
| 774 | "matterId", |
| 775 | "holdId" |
| 776 | ], |
| 777 | "parameters": { |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 778 | "holdId": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 779 | "description": "The hold ID.", |
| 780 | "location": "path", |
| 781 | "required": true, |
| 782 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 783 | }, |
| 784 | "matterId": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 785 | "description": "The matter ID.", |
| 786 | "location": "path", |
| 787 | "required": true, |
| 788 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 789 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 790 | }, |
| 791 | "path": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts", |
| 792 | "request": { |
| 793 | "$ref": "RemoveHeldAccountsRequest" |
| 794 | }, |
| 795 | "response": { |
| 796 | "$ref": "RemoveHeldAccountsResponse" |
| 797 | }, |
| 798 | "scopes": [ |
| 799 | "https://www.googleapis.com/auth/ediscovery" |
| 800 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 801 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 802 | "update": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 803 | "description": "Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 804 | "flatPath": "v1/matters/{matterId}/holds/{holdId}", |
| 805 | "httpMethod": "PUT", |
| 806 | "id": "vault.matters.holds.update", |
| 807 | "parameterOrder": [ |
| 808 | "matterId", |
| 809 | "holdId" |
| 810 | ], |
| 811 | "parameters": { |
| 812 | "holdId": { |
| 813 | "description": "The ID of the hold.", |
| 814 | "location": "path", |
| 815 | "required": true, |
| 816 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 817 | }, |
| 818 | "matterId": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 819 | "description": "The matter ID.", |
| 820 | "location": "path", |
| 821 | "required": true, |
| 822 | "type": "string" |
| 823 | } |
| 824 | }, |
| 825 | "path": "v1/matters/{matterId}/holds/{holdId}", |
| 826 | "request": { |
| 827 | "$ref": "Hold" |
| 828 | }, |
| 829 | "response": { |
| 830 | "$ref": "Hold" |
| 831 | }, |
| 832 | "scopes": [ |
| 833 | "https://www.googleapis.com/auth/ediscovery" |
| 834 | ] |
| 835 | } |
| 836 | }, |
| 837 | "resources": { |
| 838 | "accounts": { |
| 839 | "methods": { |
| 840 | "create": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 841 | "description": "Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 842 | "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", |
| 843 | "httpMethod": "POST", |
| 844 | "id": "vault.matters.holds.accounts.create", |
| 845 | "parameterOrder": [ |
| 846 | "matterId", |
| 847 | "holdId" |
| 848 | ], |
| 849 | "parameters": { |
| 850 | "holdId": { |
| 851 | "description": "The hold ID.", |
| 852 | "location": "path", |
| 853 | "required": true, |
| 854 | "type": "string" |
| 855 | }, |
| 856 | "matterId": { |
| 857 | "description": "The matter ID.", |
| 858 | "location": "path", |
| 859 | "required": true, |
| 860 | "type": "string" |
| 861 | } |
| 862 | }, |
| 863 | "path": "v1/matters/{matterId}/holds/{holdId}/accounts", |
| 864 | "request": { |
| 865 | "$ref": "HeldAccount" |
| 866 | }, |
| 867 | "response": { |
| 868 | "$ref": "HeldAccount" |
| 869 | }, |
| 870 | "scopes": [ |
| 871 | "https://www.googleapis.com/auth/ediscovery" |
| 872 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 873 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 874 | "delete": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 875 | "description": "Removes an account from a hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 876 | "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", |
| 877 | "httpMethod": "DELETE", |
| 878 | "id": "vault.matters.holds.accounts.delete", |
| 879 | "parameterOrder": [ |
| 880 | "matterId", |
| 881 | "holdId", |
| 882 | "accountId" |
| 883 | ], |
| 884 | "parameters": { |
| 885 | "accountId": { |
| 886 | "description": "The ID of the account to remove from the hold.", |
| 887 | "location": "path", |
| 888 | "required": true, |
| 889 | "type": "string" |
| 890 | }, |
| 891 | "holdId": { |
| 892 | "description": "The hold ID.", |
| 893 | "location": "path", |
| 894 | "required": true, |
| 895 | "type": "string" |
| 896 | }, |
| 897 | "matterId": { |
| 898 | "description": "The matter ID.", |
| 899 | "location": "path", |
| 900 | "required": true, |
| 901 | "type": "string" |
| 902 | } |
| 903 | }, |
| 904 | "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", |
| 905 | "response": { |
| 906 | "$ref": "Empty" |
| 907 | }, |
| 908 | "scopes": [ |
| 909 | "https://www.googleapis.com/auth/ediscovery" |
| 910 | ] |
| 911 | }, |
| 912 | "list": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 913 | "description": "Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 914 | "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", |
| 915 | "httpMethod": "GET", |
| 916 | "id": "vault.matters.holds.accounts.list", |
| 917 | "parameterOrder": [ |
| 918 | "matterId", |
| 919 | "holdId" |
| 920 | ], |
| 921 | "parameters": { |
| 922 | "holdId": { |
| 923 | "description": "The hold ID.", |
| 924 | "location": "path", |
| 925 | "required": true, |
| 926 | "type": "string" |
| 927 | }, |
| 928 | "matterId": { |
| 929 | "description": "The matter ID.", |
| 930 | "location": "path", |
| 931 | "required": true, |
| 932 | "type": "string" |
| 933 | } |
| 934 | }, |
| 935 | "path": "v1/matters/{matterId}/holds/{holdId}/accounts", |
| 936 | "response": { |
| 937 | "$ref": "ListHeldAccountsResponse" |
| 938 | }, |
| 939 | "scopes": [ |
| 940 | "https://www.googleapis.com/auth/ediscovery", |
| 941 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 942 | ] |
| 943 | } |
| 944 | } |
| 945 | } |
| 946 | } |
| 947 | }, |
| 948 | "savedQueries": { |
| 949 | "methods": { |
| 950 | "create": { |
| 951 | "description": "Creates a saved query.", |
| 952 | "flatPath": "v1/matters/{matterId}/savedQueries", |
| 953 | "httpMethod": "POST", |
| 954 | "id": "vault.matters.savedQueries.create", |
| 955 | "parameterOrder": [ |
| 956 | "matterId" |
| 957 | ], |
| 958 | "parameters": { |
| 959 | "matterId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 960 | "description": "The ID of the matter to create the saved query in.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 961 | "location": "path", |
| 962 | "required": true, |
| 963 | "type": "string" |
| 964 | } |
| 965 | }, |
| 966 | "path": "v1/matters/{matterId}/savedQueries", |
| 967 | "request": { |
| 968 | "$ref": "SavedQuery" |
| 969 | }, |
| 970 | "response": { |
| 971 | "$ref": "SavedQuery" |
| 972 | }, |
| 973 | "scopes": [ |
| 974 | "https://www.googleapis.com/auth/ediscovery" |
| 975 | ] |
| 976 | }, |
| 977 | "delete": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 978 | "description": "Deletes the specified saved query.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 979 | "flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}", |
| 980 | "httpMethod": "DELETE", |
| 981 | "id": "vault.matters.savedQueries.delete", |
| 982 | "parameterOrder": [ |
| 983 | "matterId", |
| 984 | "savedQueryId" |
| 985 | ], |
| 986 | "parameters": { |
| 987 | "matterId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 988 | "description": "The ID of the matter to delete the saved query from.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 989 | "location": "path", |
| 990 | "required": true, |
| 991 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 992 | }, |
| 993 | "savedQueryId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 994 | "description": "ID of the saved query to delete.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 995 | "location": "path", |
| 996 | "required": true, |
| 997 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 998 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 999 | }, |
| 1000 | "path": "v1/matters/{matterId}/savedQueries/{savedQueryId}", |
| 1001 | "response": { |
| 1002 | "$ref": "Empty" |
| 1003 | }, |
| 1004 | "scopes": [ |
| 1005 | "https://www.googleapis.com/auth/ediscovery" |
| 1006 | ] |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 1007 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1008 | "get": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1009 | "description": "Retrieves the specified saved query.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1010 | "flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}", |
| 1011 | "httpMethod": "GET", |
| 1012 | "id": "vault.matters.savedQueries.get", |
| 1013 | "parameterOrder": [ |
| 1014 | "matterId", |
| 1015 | "savedQueryId" |
| 1016 | ], |
| 1017 | "parameters": { |
| 1018 | "matterId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1019 | "description": "The ID of the matter to get the saved query from.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1020 | "location": "path", |
| 1021 | "required": true, |
| 1022 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 1023 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1024 | "savedQueryId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1025 | "description": "ID of the saved query to retrieve.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1026 | "location": "path", |
| 1027 | "required": true, |
| 1028 | "type": "string" |
| 1029 | } |
| 1030 | }, |
| 1031 | "path": "v1/matters/{matterId}/savedQueries/{savedQueryId}", |
| 1032 | "response": { |
| 1033 | "$ref": "SavedQuery" |
| 1034 | }, |
| 1035 | "scopes": [ |
| 1036 | "https://www.googleapis.com/auth/ediscovery", |
| 1037 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 1038 | ] |
| 1039 | }, |
| 1040 | "list": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1041 | "description": "Lists the saved queries in a matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1042 | "flatPath": "v1/matters/{matterId}/savedQueries", |
| 1043 | "httpMethod": "GET", |
| 1044 | "id": "vault.matters.savedQueries.list", |
| 1045 | "parameterOrder": [ |
| 1046 | "matterId" |
| 1047 | ], |
| 1048 | "parameters": { |
| 1049 | "matterId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1050 | "description": "The ID of the matter to get the saved queries for.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1051 | "location": "path", |
| 1052 | "required": true, |
| 1053 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 1054 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1055 | "pageSize": { |
| 1056 | "description": "The maximum number of saved queries to return.", |
| 1057 | "format": "int32", |
| 1058 | "location": "query", |
| 1059 | "type": "integer" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 1060 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1061 | "pageToken": { |
| 1062 | "description": "The pagination token as returned in the previous response. An empty token means start from the beginning.", |
| 1063 | "location": "query", |
| 1064 | "type": "string" |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 1065 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1066 | }, |
| 1067 | "path": "v1/matters/{matterId}/savedQueries", |
| 1068 | "response": { |
| 1069 | "$ref": "ListSavedQueriesResponse" |
| 1070 | }, |
| 1071 | "scopes": [ |
| 1072 | "https://www.googleapis.com/auth/ediscovery", |
| 1073 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 1074 | ] |
| 1075 | } |
| 1076 | } |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1077 | } |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1078 | } |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 1079 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1080 | "operations": { |
| 1081 | "methods": { |
| 1082 | "cancel": { |
| 1083 | "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", |
| 1084 | "flatPath": "v1/operations/{operationsId}:cancel", |
| 1085 | "httpMethod": "POST", |
| 1086 | "id": "vault.operations.cancel", |
| 1087 | "parameterOrder": [ |
| 1088 | "name" |
| 1089 | ], |
| 1090 | "parameters": { |
| 1091 | "name": { |
| 1092 | "description": "The name of the operation resource to be cancelled.", |
| 1093 | "location": "path", |
| 1094 | "pattern": "^operations/.*$", |
| 1095 | "required": true, |
| 1096 | "type": "string" |
| 1097 | } |
| 1098 | }, |
| 1099 | "path": "v1/{+name}:cancel", |
| 1100 | "request": { |
| 1101 | "$ref": "CancelOperationRequest" |
| 1102 | }, |
| 1103 | "response": { |
| 1104 | "$ref": "Empty" |
| 1105 | } |
| 1106 | }, |
| 1107 | "delete": { |
| 1108 | "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", |
| 1109 | "flatPath": "v1/operations/{operationsId}", |
| 1110 | "httpMethod": "DELETE", |
| 1111 | "id": "vault.operations.delete", |
| 1112 | "parameterOrder": [ |
| 1113 | "name" |
| 1114 | ], |
| 1115 | "parameters": { |
| 1116 | "name": { |
| 1117 | "description": "The name of the operation resource to be deleted.", |
| 1118 | "location": "path", |
| 1119 | "pattern": "^operations/.*$", |
| 1120 | "required": true, |
| 1121 | "type": "string" |
| 1122 | } |
| 1123 | }, |
| 1124 | "path": "v1/{+name}", |
| 1125 | "response": { |
| 1126 | "$ref": "Empty" |
| 1127 | } |
| 1128 | }, |
| 1129 | "get": { |
| 1130 | "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
| 1131 | "flatPath": "v1/operations/{operationsId}", |
| 1132 | "httpMethod": "GET", |
| 1133 | "id": "vault.operations.get", |
| 1134 | "parameterOrder": [ |
| 1135 | "name" |
| 1136 | ], |
| 1137 | "parameters": { |
| 1138 | "name": { |
| 1139 | "description": "The name of the operation resource.", |
| 1140 | "location": "path", |
| 1141 | "pattern": "^operations/.*$", |
| 1142 | "required": true, |
| 1143 | "type": "string" |
| 1144 | } |
| 1145 | }, |
| 1146 | "path": "v1/{+name}", |
| 1147 | "response": { |
| 1148 | "$ref": "Operation" |
| 1149 | }, |
| 1150 | "scopes": [ |
| 1151 | "https://www.googleapis.com/auth/ediscovery", |
| 1152 | "https://www.googleapis.com/auth/ediscovery.readonly" |
| 1153 | ] |
| 1154 | }, |
| 1155 | "list": { |
| 1156 | "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", |
| 1157 | "flatPath": "v1/operations", |
| 1158 | "httpMethod": "GET", |
| 1159 | "id": "vault.operations.list", |
| 1160 | "parameterOrder": [ |
| 1161 | "name" |
| 1162 | ], |
| 1163 | "parameters": { |
| 1164 | "filter": { |
| 1165 | "description": "The standard list filter.", |
| 1166 | "location": "query", |
| 1167 | "type": "string" |
| 1168 | }, |
| 1169 | "name": { |
| 1170 | "description": "The name of the operation's parent resource.", |
| 1171 | "location": "path", |
| 1172 | "pattern": "^operations$", |
| 1173 | "required": true, |
| 1174 | "type": "string" |
| 1175 | }, |
| 1176 | "pageSize": { |
| 1177 | "description": "The standard list page size.", |
| 1178 | "format": "int32", |
| 1179 | "location": "query", |
| 1180 | "type": "integer" |
| 1181 | }, |
| 1182 | "pageToken": { |
| 1183 | "description": "The standard list page token.", |
| 1184 | "location": "query", |
| 1185 | "type": "string" |
| 1186 | } |
| 1187 | }, |
| 1188 | "path": "v1/{+name}", |
| 1189 | "response": { |
| 1190 | "$ref": "ListOperationsResponse" |
| 1191 | } |
| 1192 | } |
| 1193 | } |
| 1194 | } |
| 1195 | }, |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 1196 | "revision": "20210716", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1197 | "rootUrl": "https://vault.googleapis.com/", |
| 1198 | "schemas": { |
| 1199 | "AccountCount": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1200 | "description": "The results count for each account.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1201 | "id": "AccountCount", |
| 1202 | "properties": { |
| 1203 | "account": { |
| 1204 | "$ref": "UserInfo", |
| 1205 | "description": "Account owner." |
| 1206 | }, |
| 1207 | "count": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1208 | "description": "The number of results (messages or files) found for this account.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1209 | "format": "int64", |
| 1210 | "type": "string" |
| 1211 | } |
| 1212 | }, |
| 1213 | "type": "object" |
| 1214 | }, |
| 1215 | "AccountCountError": { |
| 1216 | "description": "An error that occurred when querying a specific account", |
| 1217 | "id": "AccountCountError", |
| 1218 | "properties": { |
| 1219 | "account": { |
| 1220 | "$ref": "UserInfo", |
| 1221 | "description": "Account owner." |
| 1222 | }, |
| 1223 | "errorType": { |
| 1224 | "description": "Account query error.", |
| 1225 | "enum": [ |
| 1226 | "ERROR_TYPE_UNSPECIFIED", |
| 1227 | "WILDCARD_TOO_BROAD", |
| 1228 | "TOO_MANY_TERMS", |
| 1229 | "LOCATION_UNAVAILABLE", |
| 1230 | "UNKNOWN", |
| 1231 | "DEADLINE_EXCEEDED" |
| 1232 | ], |
| 1233 | "enumDescriptions": [ |
| 1234 | "Default.", |
| 1235 | "Permanent - prefix terms expanded to too many query terms.", |
| 1236 | "Permanent - query contains too many terms.", |
| 1237 | "Transient - data in transit between storage replicas, temporarily unavailable.", |
| 1238 | "Unrecognized error.", |
| 1239 | "Deadline exceeded when querying the account." |
| 1240 | ], |
| 1241 | "type": "string" |
| 1242 | } |
| 1243 | }, |
| 1244 | "type": "object" |
| 1245 | }, |
| 1246 | "AccountInfo": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1247 | "description": "The accounts to search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1248 | "id": "AccountInfo", |
| 1249 | "properties": { |
| 1250 | "emails": { |
| 1251 | "description": "A set of accounts to search.", |
| 1252 | "items": { |
| 1253 | "type": "string" |
| 1254 | }, |
| 1255 | "type": "array" |
| 1256 | } |
| 1257 | }, |
| 1258 | "type": "object" |
| 1259 | }, |
| 1260 | "AddHeldAccountResult": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1261 | "description": "The status of each account creation, and the **HeldAccount**, if successful.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1262 | "id": "AddHeldAccountResult", |
| 1263 | "properties": { |
| 1264 | "account": { |
| 1265 | "$ref": "HeldAccount", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1266 | "description": "Returned when the account was successfully created." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1267 | }, |
| 1268 | "status": { |
| 1269 | "$ref": "Status", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1270 | "description": "Reports the request status. If it failed, returns an error message." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1271 | } |
| 1272 | }, |
| 1273 | "type": "object" |
| 1274 | }, |
| 1275 | "AddHeldAccountsRequest": { |
| 1276 | "description": "Add a list of accounts to a hold.", |
| 1277 | "id": "AddHeldAccountsRequest", |
| 1278 | "properties": { |
| 1279 | "accountIds": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1280 | "description": "A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1281 | "items": { |
| 1282 | "type": "string" |
| 1283 | }, |
| 1284 | "type": "array" |
| 1285 | }, |
| 1286 | "emails": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1287 | "description": "A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1288 | "items": { |
| 1289 | "type": "string" |
| 1290 | }, |
| 1291 | "type": "array" |
| 1292 | } |
| 1293 | }, |
| 1294 | "type": "object" |
| 1295 | }, |
| 1296 | "AddHeldAccountsResponse": { |
| 1297 | "description": "Response for batch create held accounts.", |
| 1298 | "id": "AddHeldAccountsResponse", |
| 1299 | "properties": { |
| 1300 | "responses": { |
| 1301 | "description": "The list of responses, in the same order as the batch request.", |
| 1302 | "items": { |
| 1303 | "$ref": "AddHeldAccountResult" |
| 1304 | }, |
| 1305 | "type": "array" |
| 1306 | } |
| 1307 | }, |
| 1308 | "type": "object" |
| 1309 | }, |
| 1310 | "AddMatterPermissionsRequest": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1311 | "description": "Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1312 | "id": "AddMatterPermissionsRequest", |
| 1313 | "properties": { |
| 1314 | "ccMe": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1315 | "description": "Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1316 | "type": "boolean" |
| 1317 | }, |
| 1318 | "matterPermission": { |
| 1319 | "$ref": "MatterPermission", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1320 | "description": "The account and its role to add." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1321 | }, |
| 1322 | "sendEmails": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1323 | "description": "To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1324 | "type": "boolean" |
| 1325 | } |
| 1326 | }, |
| 1327 | "type": "object" |
| 1328 | }, |
| 1329 | "CancelOperationRequest": { |
| 1330 | "description": "The request message for Operations.CancelOperation.", |
| 1331 | "id": "CancelOperationRequest", |
| 1332 | "properties": {}, |
| 1333 | "type": "object" |
| 1334 | }, |
| 1335 | "CloseMatterRequest": { |
| 1336 | "description": "Close a matter by ID.", |
| 1337 | "id": "CloseMatterRequest", |
| 1338 | "properties": {}, |
| 1339 | "type": "object" |
| 1340 | }, |
| 1341 | "CloseMatterResponse": { |
| 1342 | "description": "Response to a CloseMatterRequest.", |
| 1343 | "id": "CloseMatterResponse", |
| 1344 | "properties": { |
| 1345 | "matter": { |
| 1346 | "$ref": "Matter", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1347 | "description": "The updated matter, with state **CLOSED**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1348 | } |
| 1349 | }, |
| 1350 | "type": "object" |
| 1351 | }, |
| 1352 | "CloudStorageFile": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1353 | "description": "The export file in Cloud Storage", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1354 | "id": "CloudStorageFile", |
| 1355 | "properties": { |
| 1356 | "bucketName": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1357 | "description": "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.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1358 | "type": "string" |
| 1359 | }, |
| 1360 | "md5Hash": { |
| 1361 | "description": "The md5 hash of the file.", |
| 1362 | "type": "string" |
| 1363 | }, |
| 1364 | "objectName": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1365 | "description": "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).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1366 | "type": "string" |
| 1367 | }, |
| 1368 | "size": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1369 | "description": "The export file size.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1370 | "format": "int64", |
| 1371 | "type": "string" |
| 1372 | } |
| 1373 | }, |
| 1374 | "type": "object" |
| 1375 | }, |
| 1376 | "CloudStorageSink": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1377 | "description": "Export sink for Cloud Storage files.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1378 | "id": "CloudStorageSink", |
| 1379 | "properties": { |
| 1380 | "files": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1381 | "description": "Output only. The exported files in Cloud Storage.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1382 | "items": { |
| 1383 | "$ref": "CloudStorageFile" |
| 1384 | }, |
| 1385 | "type": "array" |
| 1386 | } |
| 1387 | }, |
| 1388 | "type": "object" |
| 1389 | }, |
| 1390 | "CorpusQuery": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1391 | "description": "Service-specific options for holds.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1392 | "id": "CorpusQuery", |
| 1393 | "properties": { |
| 1394 | "driveQuery": { |
| 1395 | "$ref": "HeldDriveQuery", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1396 | "description": "Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1397 | }, |
| 1398 | "groupsQuery": { |
| 1399 | "$ref": "HeldGroupsQuery", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1400 | "description": "Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1401 | }, |
| 1402 | "hangoutsChatQuery": { |
| 1403 | "$ref": "HeldHangoutsChatQuery", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1404 | "description": "Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1405 | }, |
| 1406 | "mailQuery": { |
| 1407 | "$ref": "HeldMailQuery", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1408 | "description": "Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1409 | }, |
| 1410 | "voiceQuery": { |
| 1411 | "$ref": "HeldVoiceQuery", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1412 | "description": "Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1413 | } |
| 1414 | }, |
| 1415 | "type": "object" |
| 1416 | }, |
| 1417 | "CountArtifactsMetadata": { |
| 1418 | "description": "Long running operation metadata for CountArtifacts.", |
| 1419 | "id": "CountArtifactsMetadata", |
| 1420 | "properties": { |
| 1421 | "endTime": { |
| 1422 | "description": "End time of count operation. Available when operation is done.", |
| 1423 | "format": "google-datetime", |
| 1424 | "type": "string" |
| 1425 | }, |
| 1426 | "matterId": { |
| 1427 | "description": "The matter ID of the associated matter.", |
| 1428 | "type": "string" |
| 1429 | }, |
| 1430 | "query": { |
| 1431 | "$ref": "Query", |
| 1432 | "description": "The search query from the request." |
| 1433 | }, |
| 1434 | "startTime": { |
| 1435 | "description": "Creation time of count operation.", |
| 1436 | "format": "google-datetime", |
| 1437 | "type": "string" |
| 1438 | } |
| 1439 | }, |
| 1440 | "type": "object" |
| 1441 | }, |
| 1442 | "CountArtifactsRequest": { |
| 1443 | "description": "Count artifacts request.", |
| 1444 | "id": "CountArtifactsRequest", |
| 1445 | "properties": { |
| 1446 | "query": { |
| 1447 | "$ref": "Query", |
| 1448 | "description": "The search query." |
| 1449 | }, |
| 1450 | "view": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1451 | "description": "Sets the granularity of the count results.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1452 | "enum": [ |
| 1453 | "COUNT_RESULT_VIEW_UNSPECIFIED", |
| 1454 | "TOTAL_COUNT", |
| 1455 | "ALL" |
| 1456 | ], |
| 1457 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1458 | "Default. Same as **TOTAL_COUNT**.", |
| 1459 | "Response includes counts of the total accounts, queried accounts, matching accounts, non-queryable accounts, and queried account errors.", |
| 1460 | "Response includes the same details as **TOTAL_COUNT**, plus additional account breakdown." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1461 | ], |
| 1462 | "type": "string" |
| 1463 | } |
| 1464 | }, |
| 1465 | "type": "object" |
| 1466 | }, |
| 1467 | "CountArtifactsResponse": { |
| 1468 | "description": "Definition of the response for method CountArtifacts.", |
| 1469 | "id": "CountArtifactsResponse", |
| 1470 | "properties": { |
| 1471 | "groupsCountResult": { |
| 1472 | "$ref": "GroupsCountResult", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1473 | "description": "Count metrics for Groups." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1474 | }, |
| 1475 | "mailCountResult": { |
| 1476 | "$ref": "MailCountResult", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1477 | "description": "Count metrics for Gmail and classic Hangouts." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1478 | }, |
| 1479 | "totalCount": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1480 | "description": "Total count of messages.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1481 | "format": "int64", |
| 1482 | "type": "string" |
| 1483 | } |
| 1484 | }, |
| 1485 | "type": "object" |
| 1486 | }, |
| 1487 | "DriveExportOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1488 | "description": "Options for Drive exports.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1489 | "id": "DriveExportOptions", |
| 1490 | "properties": { |
| 1491 | "includeAccessInfo": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1492 | "description": "To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1493 | "type": "boolean" |
| 1494 | } |
| 1495 | }, |
| 1496 | "type": "object" |
| 1497 | }, |
| 1498 | "DriveOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1499 | "description": "Additional options for Drive search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1500 | "id": "DriveOptions", |
| 1501 | "properties": { |
| 1502 | "includeSharedDrives": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1503 | "description": "Set to **true** to include shared drives.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1504 | "type": "boolean" |
| 1505 | }, |
| 1506 | "includeTeamDrives": { |
| 1507 | "description": "Set to true to include Team Drive.", |
| 1508 | "type": "boolean" |
| 1509 | }, |
| 1510 | "versionDate": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1511 | "description": "Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1512 | "format": "google-datetime", |
| 1513 | "type": "string" |
| 1514 | } |
| 1515 | }, |
| 1516 | "type": "object" |
| 1517 | }, |
| 1518 | "Empty": { |
| 1519 | "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", |
| 1520 | "id": "Empty", |
| 1521 | "properties": {}, |
| 1522 | "type": "object" |
| 1523 | }, |
| 1524 | "Export": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1525 | "description": "An export. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1526 | "id": "Export", |
| 1527 | "properties": { |
| 1528 | "cloudStorageSink": { |
| 1529 | "$ref": "CloudStorageSink", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1530 | "description": "Output only. The sink for export files in Cloud Storage." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1531 | }, |
| 1532 | "createTime": { |
| 1533 | "description": "Output only. The time when the export was created.", |
| 1534 | "format": "google-datetime", |
| 1535 | "type": "string" |
| 1536 | }, |
| 1537 | "exportOptions": { |
| 1538 | "$ref": "ExportOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1539 | "description": "Additional export options." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1540 | }, |
| 1541 | "id": { |
| 1542 | "description": "Output only. The generated export ID.", |
| 1543 | "type": "string" |
| 1544 | }, |
| 1545 | "matterId": { |
| 1546 | "description": "Output only. The matter ID.", |
| 1547 | "type": "string" |
| 1548 | }, |
| 1549 | "name": { |
| 1550 | "description": "The export name.", |
| 1551 | "type": "string" |
| 1552 | }, |
| 1553 | "query": { |
| 1554 | "$ref": "Query", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1555 | "description": "The query parameters used to create the export." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1556 | }, |
| 1557 | "requester": { |
| 1558 | "$ref": "UserInfo", |
| 1559 | "description": "Output only. The requester of the export." |
| 1560 | }, |
| 1561 | "stats": { |
| 1562 | "$ref": "ExportStats", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1563 | "description": "Output only. Details about the export progress and size." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1564 | }, |
| 1565 | "status": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1566 | "description": "Output only. The status of the export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1567 | "enum": [ |
| 1568 | "EXPORT_STATUS_UNSPECIFIED", |
| 1569 | "COMPLETED", |
| 1570 | "FAILED", |
| 1571 | "IN_PROGRESS" |
| 1572 | ], |
| 1573 | "enumDescriptions": [ |
| 1574 | "The status is unspecified.", |
| 1575 | "The export completed.", |
| 1576 | "The export failed.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1577 | "The export is in progress." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1578 | ], |
| 1579 | "type": "string" |
| 1580 | } |
| 1581 | }, |
| 1582 | "type": "object" |
| 1583 | }, |
| 1584 | "ExportOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1585 | "description": "Additional options for exports", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1586 | "id": "ExportOptions", |
| 1587 | "properties": { |
| 1588 | "driveOptions": { |
| 1589 | "$ref": "DriveExportOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1590 | "description": "Options for Drive exports." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1591 | }, |
| 1592 | "groupsOptions": { |
| 1593 | "$ref": "GroupsExportOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1594 | "description": "Options for Groups exports." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1595 | }, |
| 1596 | "hangoutsChatOptions": { |
| 1597 | "$ref": "HangoutsChatExportOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1598 | "description": "Options for Chat exports." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1599 | }, |
| 1600 | "mailOptions": { |
| 1601 | "$ref": "MailExportOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1602 | "description": "Options for Gmail exports." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1603 | }, |
| 1604 | "region": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1605 | "description": "The requested data region for the export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1606 | "enum": [ |
| 1607 | "EXPORT_REGION_UNSPECIFIED", |
| 1608 | "ANY", |
| 1609 | "US", |
| 1610 | "EUROPE" |
| 1611 | ], |
| 1612 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1613 | "The region is unspecified. Defaults to ANY.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1614 | "Any region.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1615 | "United States region.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1616 | "Europe region." |
| 1617 | ], |
| 1618 | "type": "string" |
| 1619 | }, |
| 1620 | "voiceOptions": { |
| 1621 | "$ref": "VoiceExportOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1622 | "description": "Options for Voice exports." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1623 | } |
| 1624 | }, |
| 1625 | "type": "object" |
| 1626 | }, |
| 1627 | "ExportStats": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1628 | "description": "Progress information for an export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1629 | "id": "ExportStats", |
| 1630 | "properties": { |
| 1631 | "exportedArtifactCount": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1632 | "description": "The number of messages or files already processed for export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1633 | "format": "int64", |
| 1634 | "type": "string" |
| 1635 | }, |
| 1636 | "sizeInBytes": { |
| 1637 | "description": "The size of export in bytes.", |
| 1638 | "format": "int64", |
| 1639 | "type": "string" |
| 1640 | }, |
| 1641 | "totalArtifactCount": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1642 | "description": "The number of messages or files to be exported.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1643 | "format": "int64", |
| 1644 | "type": "string" |
| 1645 | } |
| 1646 | }, |
| 1647 | "type": "object" |
| 1648 | }, |
| 1649 | "GroupsCountResult": { |
| 1650 | "description": "Groups specific count metrics.", |
| 1651 | "id": "GroupsCountResult", |
| 1652 | "properties": { |
| 1653 | "accountCountErrors": { |
| 1654 | "description": "Error occurred when querying these accounts.", |
| 1655 | "items": { |
| 1656 | "$ref": "AccountCountError" |
| 1657 | }, |
| 1658 | "type": "array" |
| 1659 | }, |
| 1660 | "accountCounts": { |
| 1661 | "description": "Subtotal count per matching account that have more than zero messages.", |
| 1662 | "items": { |
| 1663 | "$ref": "AccountCount" |
| 1664 | }, |
| 1665 | "type": "array" |
| 1666 | }, |
| 1667 | "matchingAccountsCount": { |
| 1668 | "description": "Total number of accounts that can be queried and have more than zero messages.", |
| 1669 | "format": "int64", |
| 1670 | "type": "string" |
| 1671 | }, |
| 1672 | "nonQueryableAccounts": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1673 | "description": "When **DataScope** is **HELD_DATA**, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1674 | "items": { |
| 1675 | "type": "string" |
| 1676 | }, |
| 1677 | "type": "array" |
| 1678 | }, |
| 1679 | "queriedAccountsCount": { |
| 1680 | "description": "Total number of accounts involved in this count operation.", |
| 1681 | "format": "int64", |
| 1682 | "type": "string" |
| 1683 | } |
| 1684 | }, |
| 1685 | "type": "object" |
| 1686 | }, |
| 1687 | "GroupsExportOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1688 | "description": "Options for Groups exports.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1689 | "id": "GroupsExportOptions", |
| 1690 | "properties": { |
| 1691 | "exportFormat": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1692 | "description": "The file format for exported messages.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1693 | "enum": [ |
| 1694 | "EXPORT_FORMAT_UNSPECIFIED", |
| 1695 | "MBOX", |
| 1696 | "PST" |
| 1697 | ], |
| 1698 | "enumDescriptions": [ |
| 1699 | "No export format specified.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1700 | "Export as MBOX.", |
| 1701 | "Export as PST." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1702 | ], |
| 1703 | "type": "string" |
| 1704 | } |
| 1705 | }, |
| 1706 | "type": "object" |
| 1707 | }, |
| 1708 | "HangoutsChatExportOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1709 | "description": "Options for Chat exports.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1710 | "id": "HangoutsChatExportOptions", |
| 1711 | "properties": { |
| 1712 | "exportFormat": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1713 | "description": "The file format for exported messages.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1714 | "enum": [ |
| 1715 | "EXPORT_FORMAT_UNSPECIFIED", |
| 1716 | "MBOX", |
| 1717 | "PST" |
| 1718 | ], |
| 1719 | "enumDescriptions": [ |
| 1720 | "No export format specified.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1721 | "Export as MBOX.", |
| 1722 | "Export as PST." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1723 | ], |
| 1724 | "type": "string" |
| 1725 | } |
| 1726 | }, |
| 1727 | "type": "object" |
| 1728 | }, |
| 1729 | "HangoutsChatInfo": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1730 | "description": "The Chat spaces to search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1731 | "id": "HangoutsChatInfo", |
| 1732 | "properties": { |
| 1733 | "roomId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1734 | "description": "A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1735 | "items": { |
| 1736 | "type": "string" |
| 1737 | }, |
| 1738 | "type": "array" |
| 1739 | } |
| 1740 | }, |
| 1741 | "type": "object" |
| 1742 | }, |
| 1743 | "HangoutsChatOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1744 | "description": "Additional options for Google Chat search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1745 | "id": "HangoutsChatOptions", |
| 1746 | "properties": { |
| 1747 | "includeRooms": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1748 | "description": "For searches by account or organizational unit, set to **true** to include rooms.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1749 | "type": "boolean" |
| 1750 | } |
| 1751 | }, |
| 1752 | "type": "object" |
| 1753 | }, |
| 1754 | "HeldAccount": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1755 | "description": "An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1756 | "id": "HeldAccount", |
| 1757 | "properties": { |
| 1758 | "accountId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1759 | "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1760 | "type": "string" |
| 1761 | }, |
| 1762 | "email": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1763 | "description": "The primary email address of the account. If used as an input, this takes precedence over **accountId**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1764 | "type": "string" |
| 1765 | }, |
| 1766 | "firstName": { |
| 1767 | "description": "Output only. The first name of the account holder.", |
| 1768 | "type": "string" |
| 1769 | }, |
| 1770 | "holdTime": { |
| 1771 | "description": "Output only. When the account was put on hold.", |
| 1772 | "format": "google-datetime", |
| 1773 | "type": "string" |
| 1774 | }, |
| 1775 | "lastName": { |
| 1776 | "description": "Output only. The last name of the account holder.", |
| 1777 | "type": "string" |
| 1778 | } |
| 1779 | }, |
| 1780 | "type": "object" |
| 1781 | }, |
| 1782 | "HeldDriveQuery": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1783 | "description": "Options for Drive holds.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1784 | "id": "HeldDriveQuery", |
| 1785 | "properties": { |
| 1786 | "includeSharedDriveFiles": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1787 | "description": "To include files in shared drives in the hold, set to **true**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1788 | "type": "boolean" |
| 1789 | }, |
| 1790 | "includeTeamDriveFiles": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1791 | "description": "To include files in Team Drives in the hold, set to **true**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1792 | "type": "boolean" |
| 1793 | } |
| 1794 | }, |
| 1795 | "type": "object" |
| 1796 | }, |
| 1797 | "HeldGroupsQuery": { |
| 1798 | "description": "Query options for group holds.", |
| 1799 | "id": "HeldGroupsQuery", |
| 1800 | "properties": { |
| 1801 | "endTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1802 | "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1803 | "format": "google-datetime", |
| 1804 | "type": "string" |
| 1805 | }, |
| 1806 | "startTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1807 | "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1808 | "format": "google-datetime", |
| 1809 | "type": "string" |
| 1810 | }, |
| 1811 | "terms": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1812 | "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1813 | "type": "string" |
| 1814 | } |
| 1815 | }, |
| 1816 | "type": "object" |
| 1817 | }, |
| 1818 | "HeldHangoutsChatQuery": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1819 | "description": "Options for Chat holds.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1820 | "id": "HeldHangoutsChatQuery", |
| 1821 | "properties": { |
| 1822 | "includeRooms": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1823 | "description": "To include messages in Chat spaces the user was a member of, set to **true**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1824 | "type": "boolean" |
| 1825 | } |
| 1826 | }, |
| 1827 | "type": "object" |
| 1828 | }, |
| 1829 | "HeldMailQuery": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1830 | "description": "Query options for Gmail holds.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1831 | "id": "HeldMailQuery", |
| 1832 | "properties": { |
| 1833 | "endTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1834 | "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1835 | "format": "google-datetime", |
| 1836 | "type": "string" |
| 1837 | }, |
| 1838 | "startTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1839 | "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1840 | "format": "google-datetime", |
| 1841 | "type": "string" |
| 1842 | }, |
| 1843 | "terms": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1844 | "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1845 | "type": "string" |
| 1846 | } |
| 1847 | }, |
| 1848 | "type": "object" |
| 1849 | }, |
| 1850 | "HeldOrgUnit": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1851 | "description": "The organizational unit covered by a hold. This structure is immutable.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1852 | "id": "HeldOrgUnit", |
| 1853 | "properties": { |
| 1854 | "holdTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1855 | "description": "When the organizational unit was put on hold. This property is immutable.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1856 | "format": "google-datetime", |
| 1857 | "type": "string" |
| 1858 | }, |
| 1859 | "orgUnitId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1860 | "description": "The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1861 | "type": "string" |
| 1862 | } |
| 1863 | }, |
| 1864 | "type": "object" |
| 1865 | }, |
| 1866 | "HeldVoiceQuery": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1867 | "description": "Options for Voice holds.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1868 | "id": "HeldVoiceQuery", |
| 1869 | "properties": { |
| 1870 | "coveredData": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1871 | "description": "A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1872 | "items": { |
| 1873 | "enum": [ |
| 1874 | "COVERED_DATA_UNSPECIFIED", |
| 1875 | "TEXT_MESSAGES", |
| 1876 | "VOICEMAILS", |
| 1877 | "CALL_LOGS" |
| 1878 | ], |
| 1879 | "enumDescriptions": [ |
| 1880 | "Covered data unspecified.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1881 | "Voice text messages.", |
| 1882 | "Voicemails and their transcripts.", |
| 1883 | "Call logs." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1884 | ], |
| 1885 | "type": "string" |
| 1886 | }, |
| 1887 | "type": "array" |
| 1888 | } |
| 1889 | }, |
| 1890 | "type": "object" |
| 1891 | }, |
| 1892 | "Hold": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1893 | "description": "A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1894 | "id": "Hold", |
| 1895 | "properties": { |
| 1896 | "accounts": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1897 | "description": "If set, the hold applies to the specified accounts and **orgUnit** must be empty.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1898 | "items": { |
| 1899 | "$ref": "HeldAccount" |
| 1900 | }, |
| 1901 | "type": "array" |
| 1902 | }, |
| 1903 | "corpus": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1904 | "description": "The service to be searched.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1905 | "enum": [ |
| 1906 | "CORPUS_TYPE_UNSPECIFIED", |
| 1907 | "DRIVE", |
| 1908 | "MAIL", |
| 1909 | "GROUPS", |
| 1910 | "HANGOUTS_CHAT", |
| 1911 | "VOICE" |
| 1912 | ], |
| 1913 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1914 | "No service specified.", |
| 1915 | "Drive, including Meet and Sites.", |
| 1916 | "For search, Gmail and classic Hangouts. For holds, Gmail only.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1917 | "Groups.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1918 | "For search, Google Chat only. For holds, Google Chat and classic Hangouts.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1919 | "Google Voice." |
| 1920 | ], |
| 1921 | "type": "string" |
| 1922 | }, |
| 1923 | "holdId": { |
| 1924 | "description": "The unique immutable ID of the hold. Assigned during creation.", |
| 1925 | "type": "string" |
| 1926 | }, |
| 1927 | "name": { |
| 1928 | "description": "The name of the hold.", |
| 1929 | "type": "string" |
| 1930 | }, |
| 1931 | "orgUnit": { |
| 1932 | "$ref": "HeldOrgUnit", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1933 | "description": "If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1934 | }, |
| 1935 | "query": { |
| 1936 | "$ref": "CorpusQuery", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1937 | "description": "Service-specific options. If set, **CorpusQuery** must match **CorpusType**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1938 | }, |
| 1939 | "updateTime": { |
| 1940 | "description": "The last time this hold was modified.", |
| 1941 | "format": "google-datetime", |
| 1942 | "type": "string" |
| 1943 | } |
| 1944 | }, |
| 1945 | "type": "object" |
| 1946 | }, |
| 1947 | "ListExportsResponse": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1948 | "description": "The exports for a matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1949 | "id": "ListExportsResponse", |
| 1950 | "properties": { |
| 1951 | "exports": { |
| 1952 | "description": "The list of exports.", |
| 1953 | "items": { |
| 1954 | "$ref": "Export" |
| 1955 | }, |
| 1956 | "type": "array" |
| 1957 | }, |
| 1958 | "nextPageToken": { |
| 1959 | "description": "Page token to retrieve the next page of results in the list.", |
| 1960 | "type": "string" |
| 1961 | } |
| 1962 | }, |
| 1963 | "type": "object" |
| 1964 | }, |
| 1965 | "ListHeldAccountsResponse": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1966 | "description": "Returns a list of the accounts covered by a hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1967 | "id": "ListHeldAccountsResponse", |
| 1968 | "properties": { |
| 1969 | "accounts": { |
| 1970 | "description": "The held accounts on a hold.", |
| 1971 | "items": { |
| 1972 | "$ref": "HeldAccount" |
| 1973 | }, |
| 1974 | "type": "array" |
| 1975 | } |
| 1976 | }, |
| 1977 | "type": "object" |
| 1978 | }, |
| 1979 | "ListHoldsResponse": { |
| 1980 | "description": "The holds for a matter.", |
| 1981 | "id": "ListHoldsResponse", |
| 1982 | "properties": { |
| 1983 | "holds": { |
| 1984 | "description": "The list of holds.", |
| 1985 | "items": { |
| 1986 | "$ref": "Hold" |
| 1987 | }, |
| 1988 | "type": "array" |
| 1989 | }, |
| 1990 | "nextPageToken": { |
| 1991 | "description": "Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.", |
| 1992 | "type": "string" |
| 1993 | } |
| 1994 | }, |
| 1995 | "type": "object" |
| 1996 | }, |
| 1997 | "ListMattersResponse": { |
| 1998 | "description": "Provides the list of matters.", |
| 1999 | "id": "ListMattersResponse", |
| 2000 | "properties": { |
| 2001 | "matters": { |
| 2002 | "description": "List of matters.", |
| 2003 | "items": { |
| 2004 | "$ref": "Matter" |
| 2005 | }, |
| 2006 | "type": "array" |
| 2007 | }, |
| 2008 | "nextPageToken": { |
| 2009 | "description": "Page token to retrieve the next page of results in the list.", |
| 2010 | "type": "string" |
| 2011 | } |
| 2012 | }, |
| 2013 | "type": "object" |
| 2014 | }, |
| 2015 | "ListOperationsResponse": { |
| 2016 | "description": "The response message for Operations.ListOperations.", |
| 2017 | "id": "ListOperationsResponse", |
| 2018 | "properties": { |
| 2019 | "nextPageToken": { |
| 2020 | "description": "The standard List next-page token.", |
| 2021 | "type": "string" |
| 2022 | }, |
| 2023 | "operations": { |
| 2024 | "description": "A list of operations that matches the specified filter in the request.", |
| 2025 | "items": { |
| 2026 | "$ref": "Operation" |
| 2027 | }, |
| 2028 | "type": "array" |
| 2029 | } |
| 2030 | }, |
| 2031 | "type": "object" |
| 2032 | }, |
| 2033 | "ListSavedQueriesResponse": { |
| 2034 | "description": "Definition of the response for method ListSaveQuery.", |
| 2035 | "id": "ListSavedQueriesResponse", |
| 2036 | "properties": { |
| 2037 | "nextPageToken": { |
| 2038 | "description": "Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list.", |
| 2039 | "type": "string" |
| 2040 | }, |
| 2041 | "savedQueries": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2042 | "description": "List of saved queries.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2043 | "items": { |
| 2044 | "$ref": "SavedQuery" |
| 2045 | }, |
| 2046 | "type": "array" |
| 2047 | } |
| 2048 | }, |
| 2049 | "type": "object" |
| 2050 | }, |
| 2051 | "MailCountResult": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2052 | "description": "Gmail and classic Hangouts-specific count metrics.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2053 | "id": "MailCountResult", |
| 2054 | "properties": { |
| 2055 | "accountCountErrors": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2056 | "description": "Errors occurred when querying these accounts.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2057 | "items": { |
| 2058 | "$ref": "AccountCountError" |
| 2059 | }, |
| 2060 | "type": "array" |
| 2061 | }, |
| 2062 | "accountCounts": { |
| 2063 | "description": "Subtotal count per matching account that have more than zero messages.", |
| 2064 | "items": { |
| 2065 | "$ref": "AccountCount" |
| 2066 | }, |
| 2067 | "type": "array" |
| 2068 | }, |
| 2069 | "matchingAccountsCount": { |
| 2070 | "description": "Total number of accounts that can be queried and have more than zero messages.", |
| 2071 | "format": "int64", |
| 2072 | "type": "string" |
| 2073 | }, |
| 2074 | "nonQueryableAccounts": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2075 | "description": "When **DataScope** is **HELD_DATA**, the number of accounts in the request that are not queried because they are not on hold. For other data scopes, this field is not set.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2076 | "items": { |
| 2077 | "type": "string" |
| 2078 | }, |
| 2079 | "type": "array" |
| 2080 | }, |
| 2081 | "queriedAccountsCount": { |
| 2082 | "description": "Total number of accounts involved in this count operation.", |
| 2083 | "format": "int64", |
| 2084 | "type": "string" |
| 2085 | } |
| 2086 | }, |
| 2087 | "type": "object" |
| 2088 | }, |
| 2089 | "MailExportOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2090 | "description": "Options for Gmail exports.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2091 | "id": "MailExportOptions", |
| 2092 | "properties": { |
| 2093 | "exportFormat": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2094 | "description": "The file format for exported messages.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2095 | "enum": [ |
| 2096 | "EXPORT_FORMAT_UNSPECIFIED", |
| 2097 | "MBOX", |
| 2098 | "PST" |
| 2099 | ], |
| 2100 | "enumDescriptions": [ |
| 2101 | "No export format specified.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2102 | "Export as MBOX.", |
| 2103 | "Export as PST." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2104 | ], |
| 2105 | "type": "string" |
| 2106 | }, |
| 2107 | "showConfidentialModeContent": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2108 | "description": "To export confidential mode content, set to **true**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2109 | "type": "boolean" |
| 2110 | } |
| 2111 | }, |
| 2112 | "type": "object" |
| 2113 | }, |
| 2114 | "MailOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2115 | "description": "Additional options for Gmail search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2116 | "id": "MailOptions", |
| 2117 | "properties": { |
| 2118 | "excludeDrafts": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2119 | "description": "Set to **true** to exclude drafts.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2120 | "type": "boolean" |
| 2121 | } |
| 2122 | }, |
| 2123 | "type": "object" |
| 2124 | }, |
| 2125 | "Matter": { |
| 2126 | "description": "Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.", |
| 2127 | "id": "Matter", |
| 2128 | "properties": { |
| 2129 | "description": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2130 | "description": "An optional description for the matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2131 | "type": "string" |
| 2132 | }, |
| 2133 | "matterId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2134 | "description": "The matter ID, which is generated by the server. Leave blank when creating a matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2135 | "type": "string" |
| 2136 | }, |
| 2137 | "matterPermissions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2138 | "description": "Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2139 | "items": { |
| 2140 | "$ref": "MatterPermission" |
| 2141 | }, |
| 2142 | "type": "array" |
| 2143 | }, |
| 2144 | "name": { |
| 2145 | "description": "The name of the matter.", |
| 2146 | "type": "string" |
| 2147 | }, |
| 2148 | "state": { |
| 2149 | "description": "The state of the matter.", |
| 2150 | "enum": [ |
| 2151 | "STATE_UNSPECIFIED", |
| 2152 | "OPEN", |
| 2153 | "CLOSED", |
| 2154 | "DELETED" |
| 2155 | ], |
| 2156 | "enumDescriptions": [ |
| 2157 | "The matter has no specified state.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2158 | "The matter is open.", |
| 2159 | "The matter is closed.", |
| 2160 | "The matter is deleted." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2161 | ], |
| 2162 | "type": "string" |
| 2163 | } |
| 2164 | }, |
| 2165 | "type": "object" |
| 2166 | }, |
| 2167 | "MatterPermission": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2168 | "description": "Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2169 | "id": "MatterPermission", |
| 2170 | "properties": { |
| 2171 | "accountId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2172 | "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2173 | "type": "string" |
| 2174 | }, |
| 2175 | "role": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2176 | "description": "The user's role for the matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2177 | "enum": [ |
| 2178 | "ROLE_UNSPECIFIED", |
| 2179 | "COLLABORATOR", |
| 2180 | "OWNER" |
| 2181 | ], |
| 2182 | "enumDescriptions": [ |
| 2183 | "No role assigned.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2184 | "A collaborator on the matter.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2185 | "The owner of the matter." |
| 2186 | ], |
| 2187 | "type": "string" |
| 2188 | } |
| 2189 | }, |
| 2190 | "type": "object" |
| 2191 | }, |
| 2192 | "Operation": { |
| 2193 | "description": "This resource represents a long-running operation that is the result of a network API call.", |
| 2194 | "id": "Operation", |
| 2195 | "properties": { |
| 2196 | "done": { |
| 2197 | "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", |
| 2198 | "type": "boolean" |
| 2199 | }, |
| 2200 | "error": { |
| 2201 | "$ref": "Status", |
| 2202 | "description": "The error result of the operation in case of failure or cancellation." |
| 2203 | }, |
| 2204 | "metadata": { |
| 2205 | "additionalProperties": { |
| 2206 | "description": "Properties of the object. Contains field @type with type URL.", |
| 2207 | "type": "any" |
| 2208 | }, |
| 2209 | "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", |
| 2210 | "type": "object" |
| 2211 | }, |
| 2212 | "name": { |
| 2213 | "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", |
| 2214 | "type": "string" |
| 2215 | }, |
| 2216 | "response": { |
| 2217 | "additionalProperties": { |
| 2218 | "description": "Properties of the object. Contains field @type with type URL.", |
| 2219 | "type": "any" |
| 2220 | }, |
| 2221 | "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", |
| 2222 | "type": "object" |
| 2223 | } |
| 2224 | }, |
| 2225 | "type": "object" |
| 2226 | }, |
| 2227 | "OrgUnitInfo": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2228 | "description": "The organizational unit to search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2229 | "id": "OrgUnitInfo", |
| 2230 | "properties": { |
| 2231 | "orgUnitId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2232 | "description": "The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2233 | "type": "string" |
| 2234 | } |
| 2235 | }, |
| 2236 | "type": "object" |
| 2237 | }, |
| 2238 | "Query": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2239 | "description": "The query definition used for search and export.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2240 | "id": "Query", |
| 2241 | "properties": { |
| 2242 | "accountInfo": { |
| 2243 | "$ref": "AccountInfo", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2244 | "description": "Required when **SearchMethod** is **ACCOUNT**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2245 | }, |
| 2246 | "corpus": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2247 | "description": "The Google Workspace service to search.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2248 | "enum": [ |
| 2249 | "CORPUS_TYPE_UNSPECIFIED", |
| 2250 | "DRIVE", |
| 2251 | "MAIL", |
| 2252 | "GROUPS", |
| 2253 | "HANGOUTS_CHAT", |
| 2254 | "VOICE" |
| 2255 | ], |
| 2256 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2257 | "No service specified.", |
| 2258 | "Drive, including Meet and Sites.", |
| 2259 | "For search, Gmail and classic Hangouts. For holds, Gmail only.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2260 | "Groups.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2261 | "For search, Google Chat only. For holds, Google Chat and classic Hangouts.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2262 | "Google Voice." |
| 2263 | ], |
| 2264 | "type": "string" |
| 2265 | }, |
| 2266 | "dataScope": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2267 | "description": "The data source to search.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2268 | "enum": [ |
| 2269 | "DATA_SCOPE_UNSPECIFIED", |
| 2270 | "ALL_DATA", |
| 2271 | "HELD_DATA", |
| 2272 | "UNPROCESSED_DATA" |
| 2273 | ], |
| 2274 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2275 | "No data source specified.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2276 | "All available data.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2277 | "Only data on hold.", |
| 2278 | "Only data not yet processed by Vault. (Gmail and Groups only)" |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2279 | ], |
| 2280 | "type": "string" |
| 2281 | }, |
| 2282 | "driveOptions": { |
| 2283 | "$ref": "DriveOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2284 | "description": "Set Drive search-specific options." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2285 | }, |
| 2286 | "endTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2287 | "description": "The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2288 | "format": "google-datetime", |
| 2289 | "type": "string" |
| 2290 | }, |
| 2291 | "hangoutsChatInfo": { |
| 2292 | "$ref": "HangoutsChatInfo", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2293 | "description": "Required when **SearchMethod** is **ROOM**. (read-only)" |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2294 | }, |
| 2295 | "hangoutsChatOptions": { |
| 2296 | "$ref": "HangoutsChatOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2297 | "description": "Set Chat search-specific options. (read-only)" |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2298 | }, |
| 2299 | "mailOptions": { |
| 2300 | "$ref": "MailOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2301 | "description": "Set Gmail search-specific options." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2302 | }, |
| 2303 | "method": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2304 | "description": "The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2305 | "enum": [ |
| 2306 | "SEARCH_METHOD_UNSPECIFIED", |
| 2307 | "ACCOUNT", |
| 2308 | "ORG_UNIT", |
| 2309 | "TEAM_DRIVE", |
| 2310 | "ENTIRE_ORG", |
| 2311 | "ROOM", |
| 2312 | "SHARED_DRIVE" |
| 2313 | ], |
| 2314 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2315 | "A search method must be specified or else it is rejected.", |
| 2316 | "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Query#accountinfo).", |
| 2317 | "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Query#orgunitinfo).", |
| 2318 | "Search the data in the Team Drive specified in **team_drive_info**.", |
| 2319 | "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", |
| 2320 | "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).", |
| 2321 | "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.devsite.corp.google.com/vault/reference/rest/v1/Query#shareddriveinfo)." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2322 | ], |
| 2323 | "type": "string" |
| 2324 | }, |
| 2325 | "orgUnitInfo": { |
| 2326 | "$ref": "OrgUnitInfo", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2327 | "description": "Required when **SearchMethod** is **ORG_UNIT**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2328 | }, |
| 2329 | "searchMethod": { |
| 2330 | "description": "The search method to use.", |
| 2331 | "enum": [ |
| 2332 | "SEARCH_METHOD_UNSPECIFIED", |
| 2333 | "ACCOUNT", |
| 2334 | "ORG_UNIT", |
| 2335 | "TEAM_DRIVE", |
| 2336 | "ENTIRE_ORG", |
| 2337 | "ROOM", |
| 2338 | "SHARED_DRIVE" |
| 2339 | ], |
| 2340 | "enumDescriptions": [ |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2341 | "A search method must be specified or else it is rejected.", |
| 2342 | "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Query#accountinfo).", |
| 2343 | "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Query#orgunitinfo).", |
| 2344 | "Search the data in the Team Drive specified in **team_drive_info**.", |
| 2345 | "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", |
| 2346 | "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).", |
| 2347 | "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.devsite.corp.google.com/vault/reference/rest/v1/Query#shareddriveinfo)." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2348 | ], |
| 2349 | "type": "string" |
| 2350 | }, |
| 2351 | "sharedDriveInfo": { |
| 2352 | "$ref": "SharedDriveInfo", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2353 | "description": "Required when **SearchMethod** is **SHARED_DRIVE**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2354 | }, |
| 2355 | "startTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2356 | "description": "The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2357 | "format": "google-datetime", |
| 2358 | "type": "string" |
| 2359 | }, |
| 2360 | "teamDriveInfo": { |
| 2361 | "$ref": "TeamDriveInfo", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2362 | "description": "Required when **SearchMethod** is **TEAM_DRIVE**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2363 | }, |
| 2364 | "terms": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2365 | "description": "Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2366 | "type": "string" |
| 2367 | }, |
| 2368 | "timeZone": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2369 | "description": "The time zone name. It should be an IANA TZ name, such as \"America/Los_Angeles\". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2370 | "type": "string" |
| 2371 | }, |
| 2372 | "voiceOptions": { |
| 2373 | "$ref": "VoiceOptions", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2374 | "description": "Set Voice search-specific options." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2375 | } |
| 2376 | }, |
| 2377 | "type": "object" |
| 2378 | }, |
| 2379 | "RemoveHeldAccountsRequest": { |
| 2380 | "description": "Remove a list of accounts from a hold.", |
| 2381 | "id": "RemoveHeldAccountsRequest", |
| 2382 | "properties": { |
| 2383 | "accountIds": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2384 | "description": "The account IDs of the accounts to remove from the hold.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2385 | "items": { |
| 2386 | "type": "string" |
| 2387 | }, |
| 2388 | "type": "array" |
| 2389 | } |
| 2390 | }, |
| 2391 | "type": "object" |
| 2392 | }, |
| 2393 | "RemoveHeldAccountsResponse": { |
| 2394 | "description": "Response for batch delete held accounts.", |
| 2395 | "id": "RemoveHeldAccountsResponse", |
| 2396 | "properties": { |
| 2397 | "statuses": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2398 | "description": "A list of statuses for the deleted accounts. Results have the same order as the request.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2399 | "items": { |
| 2400 | "$ref": "Status" |
| 2401 | }, |
| 2402 | "type": "array" |
| 2403 | } |
| 2404 | }, |
| 2405 | "type": "object" |
| 2406 | }, |
| 2407 | "RemoveMatterPermissionsRequest": { |
| 2408 | "description": "Remove an account as a matter collaborator.", |
| 2409 | "id": "RemoveMatterPermissionsRequest", |
| 2410 | "properties": { |
| 2411 | "accountId": { |
| 2412 | "description": "The account ID.", |
| 2413 | "type": "string" |
| 2414 | } |
| 2415 | }, |
| 2416 | "type": "object" |
| 2417 | }, |
| 2418 | "ReopenMatterRequest": { |
| 2419 | "description": "Reopen a matter by ID.", |
| 2420 | "id": "ReopenMatterRequest", |
| 2421 | "properties": {}, |
| 2422 | "type": "object" |
| 2423 | }, |
| 2424 | "ReopenMatterResponse": { |
| 2425 | "description": "Response to a ReopenMatterRequest.", |
| 2426 | "id": "ReopenMatterResponse", |
| 2427 | "properties": { |
| 2428 | "matter": { |
| 2429 | "$ref": "Matter", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2430 | "description": "The updated matter, with state **OPEN**." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2431 | } |
| 2432 | }, |
| 2433 | "type": "object" |
| 2434 | }, |
| 2435 | "SavedQuery": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2436 | "description": "The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2437 | "id": "SavedQuery", |
| 2438 | "properties": { |
| 2439 | "createTime": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2440 | "description": "Output only. The server-generated timestamp when the saved query was created.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2441 | "format": "google-datetime", |
| 2442 | "type": "string" |
| 2443 | }, |
| 2444 | "displayName": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2445 | "description": "The name of the saved query.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2446 | "type": "string" |
| 2447 | }, |
| 2448 | "matterId": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2449 | "description": "Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2450 | "type": "string" |
| 2451 | }, |
| 2452 | "query": { |
| 2453 | "$ref": "Query", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2454 | "description": "The search parameters of the saved query." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2455 | }, |
| 2456 | "savedQueryId": { |
| 2457 | "description": "A unique identifier for the saved query.", |
| 2458 | "type": "string" |
| 2459 | } |
| 2460 | }, |
| 2461 | "type": "object" |
| 2462 | }, |
| 2463 | "SharedDriveInfo": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2464 | "description": "The shared drives to search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2465 | "id": "SharedDriveInfo", |
| 2466 | "properties": { |
| 2467 | "sharedDriveIds": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2468 | "description": "A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2469 | "items": { |
| 2470 | "type": "string" |
| 2471 | }, |
| 2472 | "type": "array" |
| 2473 | } |
| 2474 | }, |
| 2475 | "type": "object" |
| 2476 | }, |
| 2477 | "Status": { |
| 2478 | "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", |
| 2479 | "id": "Status", |
| 2480 | "properties": { |
| 2481 | "code": { |
| 2482 | "description": "The status code, which should be an enum value of google.rpc.Code.", |
| 2483 | "format": "int32", |
| 2484 | "type": "integer" |
| 2485 | }, |
| 2486 | "details": { |
| 2487 | "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", |
| 2488 | "items": { |
| 2489 | "additionalProperties": { |
| 2490 | "description": "Properties of the object. Contains field @type with type URL.", |
| 2491 | "type": "any" |
| 2492 | }, |
| 2493 | "type": "object" |
| 2494 | }, |
| 2495 | "type": "array" |
| 2496 | }, |
| 2497 | "message": { |
| 2498 | "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", |
| 2499 | "type": "string" |
| 2500 | } |
| 2501 | }, |
| 2502 | "type": "object" |
| 2503 | }, |
| 2504 | "TeamDriveInfo": { |
| 2505 | "description": "Team Drives to search", |
| 2506 | "id": "TeamDriveInfo", |
| 2507 | "properties": { |
| 2508 | "teamDriveIds": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2509 | "description": "List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2510 | "items": { |
| 2511 | "type": "string" |
| 2512 | }, |
| 2513 | "type": "array" |
| 2514 | } |
| 2515 | }, |
| 2516 | "type": "object" |
| 2517 | }, |
| 2518 | "UndeleteMatterRequest": { |
| 2519 | "description": "Undelete a matter by ID.", |
| 2520 | "id": "UndeleteMatterRequest", |
| 2521 | "properties": {}, |
| 2522 | "type": "object" |
| 2523 | }, |
| 2524 | "UserInfo": { |
| 2525 | "description": "User's information.", |
| 2526 | "id": "UserInfo", |
| 2527 | "properties": { |
| 2528 | "displayName": { |
| 2529 | "description": "The displayed name of the user.", |
| 2530 | "type": "string" |
| 2531 | }, |
| 2532 | "email": { |
| 2533 | "description": "The email address of the user.", |
| 2534 | "type": "string" |
| 2535 | } |
| 2536 | }, |
| 2537 | "type": "object" |
| 2538 | }, |
| 2539 | "VoiceExportOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2540 | "description": "The options for Voice exports.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2541 | "id": "VoiceExportOptions", |
| 2542 | "properties": { |
| 2543 | "exportFormat": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2544 | "description": "The file format for exported text messages.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2545 | "enum": [ |
| 2546 | "EXPORT_FORMAT_UNSPECIFIED", |
| 2547 | "MBOX", |
| 2548 | "PST" |
| 2549 | ], |
| 2550 | "enumDescriptions": [ |
| 2551 | "No export format specified.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2552 | "Export as MBOX.", |
| 2553 | "Export as PST." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2554 | ], |
| 2555 | "type": "string" |
| 2556 | } |
| 2557 | }, |
| 2558 | "type": "object" |
| 2559 | }, |
| 2560 | "VoiceOptions": { |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2561 | "description": "Additional options for Voice search", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2562 | "id": "VoiceOptions", |
| 2563 | "properties": { |
| 2564 | "coveredData": { |
| 2565 | "description": "Datatypes to search", |
| 2566 | "items": { |
| 2567 | "enum": [ |
| 2568 | "COVERED_DATA_UNSPECIFIED", |
| 2569 | "TEXT_MESSAGES", |
| 2570 | "VOICEMAILS", |
| 2571 | "CALL_LOGS" |
| 2572 | ], |
| 2573 | "enumDescriptions": [ |
| 2574 | "Covered data unspecified.", |
yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 2575 | "Voice text messages.", |
| 2576 | "Voicemails and their transcripts.", |
| 2577 | "Call logs." |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 2578 | ], |
| 2579 | "type": "string" |
| 2580 | }, |
| 2581 | "type": "array" |
| 2582 | } |
| 2583 | }, |
| 2584 | "type": "object" |
| 2585 | } |
| 2586 | }, |
| 2587 | "servicePath": "", |
| 2588 | "title": "G Suite Vault API", |
| 2589 | "version": "v1", |
| 2590 | "version_module": true |
yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame] | 2591 | } |