1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="vault_v1.html">G Suite Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.holds.html">holds</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="vault_v1.matters.holds.accounts.html">accounts()</a></code> 79</p> 80<p class="firstline">Returns the accounts Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#addHeldAccounts">addHeldAccounts(matterId, holdId, body, x__xgafv=None)</a></code></p> 84<p class="firstline">Adds HeldAccounts to a hold. Returns a list of accounts that have been</p> 85<p class="toc_element"> 86 <code><a href="#create">create(matterId, body, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a hold in the given matter.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(matterId, holdId, x__xgafv=None)</a></code></p> 90<p class="firstline">Removes a hold by ID. This will release any HeldAccounts on this Hold.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(matterId, holdId, x__xgafv=None, view=None)</a></code></p> 93<p class="firstline">Gets a hold by ID.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p> 96<p class="firstline">Lists holds within a matter. An empty page token in ListHoldsResponse</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body, x__xgafv=None)</a></code></p> 102<p class="firstline">Removes HeldAccounts from a hold. Returns a list of statuses in the same</p> 103<p class="toc_element"> 104 <code><a href="#update">update(matterId, holdId, body, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates the OU and/or query parameters of a hold. You cannot add accounts</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body, x__xgafv=None)</code> 109 <pre>Adds HeldAccounts to a hold. Returns a list of accounts that have been 110successfully added. Accounts can only be added to an existing account-based 111hold. 112 113Args: 114 matterId: string, The matter ID. (required) 115 holdId: string, The hold ID. (required) 116 body: object, The request body. (required) 117 The object takes the form of: 118 119{ # Add a list of accounts to a hold. 120 "accountIds": [ # Account ids to identify which accounts to add. Only account_ids or only 121 # emails should be specified, but not both. 122 "A String", 123 ], 124 "emails": [ # Emails to identify which accounts to add. Only emails or only account_ids 125 # should be specified, but not both. 126 "A String", 127 ], 128 } 129 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # Response for batch create held accounts. 139 "responses": [ # The list of responses, in the same order as the batch request. 140 { # A status detailing the status of each account creation, and the 141 # HeldAccount, if successful. 142 "status": { # The `Status` type defines a logical error model that is suitable for # This represents the success status. If failed, check message. 143 # different programming environments, including REST APIs and RPC APIs. It is 144 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 145 # 146 # - Simple to use and understand for most users 147 # - Flexible enough to meet unexpected needs 148 # 149 # # Overview 150 # 151 # The `Status` message contains three pieces of data: error code, error 152 # message, and error details. The error code should be an enum value of 153 # google.rpc.Code, but it may accept additional error codes if needed. The 154 # error message should be a developer-facing English message that helps 155 # developers *understand* and *resolve* the error. If a localized user-facing 156 # error message is needed, put the localized message in the error details or 157 # localize it in the client. The optional error details may contain arbitrary 158 # information about the error. There is a predefined set of error detail types 159 # in the package `google.rpc` that can be used for common error conditions. 160 # 161 # # Language mapping 162 # 163 # The `Status` message is the logical representation of the error model, but it 164 # is not necessarily the actual wire format. When the `Status` message is 165 # exposed in different client libraries and different wire protocols, it can be 166 # mapped differently. For example, it will likely be mapped to some exceptions 167 # in Java, but more likely mapped to some error codes in C. 168 # 169 # # Other uses 170 # 171 # The error model and the `Status` message can be used in a variety of 172 # environments, either with or without APIs, to provide a 173 # consistent developer experience across different environments. 174 # 175 # Example uses of this error model include: 176 # 177 # - Partial errors. If a service needs to return partial errors to the client, 178 # it may embed the `Status` in the normal response to indicate the partial 179 # errors. 180 # 181 # - Workflow errors. A typical workflow has multiple steps. Each step may 182 # have a `Status` message for error reporting. 183 # 184 # - Batch operations. If a client uses batch request and batch response, the 185 # `Status` message should be used directly inside batch response, one for 186 # each error sub-response. 187 # 188 # - Asynchronous operations. If an API call embeds asynchronous operation 189 # results in its response, the status of those operations should be 190 # represented directly using the `Status` message. 191 # 192 # - Logging. If some API errors are stored in logs, the message `Status` could 193 # be used directly after any stripping needed for security/privacy reasons. 194 "message": "A String", # A developer-facing error message, which should be in English. Any 195 # user-facing error message should be localized and sent in the 196 # google.rpc.Status.details field, or localized by the client. 197 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 198 "details": [ # A list of messages that carry the error details. There is a common set of 199 # message types for APIs to use. 200 { 201 "a_key": "", # Properties of the object. Contains field @type with type URL. 202 }, 203 ], 204 }, 205 "account": { # An account being held in a particular hold. This structure is immutable. # If present, this account was successfully created. 206 # This can be either a single user or a google group, depending on the corpus. 207 "lastName": "A String", # Output only. The last name of the account holder. 208 "holdTime": "A String", # Output only. When the account was put on hold. 209 "email": "A String", # The primary email address of the account. If used as an input, this takes 210 # precedence over account ID. 211 "firstName": "A String", # Output only. The first name of the account holder. 212 "accountId": "A String", # The account's ID as provided by the 213 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 214 }, 215 }, 216 ], 217 }</pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="create">create(matterId, body, x__xgafv=None)</code> 222 <pre>Creates a hold in the given matter. 223 224Args: 225 matterId: string, The matter ID. (required) 226 body: object, The request body. (required) 227 The object takes the form of: 228 229{ # Represents a hold within Vault. A hold restricts purging of 230 # artifacts based on the combination of the query and accounts restrictions. 231 # A hold can be configured to either apply to an explicitly configured set 232 # of accounts, or can be applied to all members of an organizational unit. 233 "updateTime": "A String", # The last time this hold was modified. 234 "name": "A String", # The name of the hold. 235 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and 236 # accounts must be empty. This property is mutable. For groups holds, 237 # set the accounts field. 238 # This structure is immutable. 239 "holdTime": "A String", # When the org unit was put on hold. This property is immutable. 240 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. 241 }, 242 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be 243 # empty. 244 { # An account being held in a particular hold. This structure is immutable. 245 # This can be either a single user or a google group, depending on the corpus. 246 "lastName": "A String", # Output only. The last name of the account holder. 247 "holdTime": "A String", # Output only. When the account was put on hold. 248 "email": "A String", # The primary email address of the account. If used as an input, this takes 249 # precedence over account ID. 250 "firstName": "A String", # Output only. The first name of the account holder. 251 "accountId": "A String", # The account's ID as provided by the 252 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 253 }, 254 ], 255 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus 256 # type. 257 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be 258 # Hangouts Chat. 259 "includeRooms": True or False, # If true, include rooms the user has participated in. 260 }, 261 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. 262 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. 263 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. 264 }, 265 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. 266 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 267 # rounded down to the start of the given date. 268 "terms": "A String", # The search terms for the hold. 269 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 270 # rounded down to the start of the given date. 271 }, 272 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. 273 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 274 # rounded down to the start of the given date. 275 "terms": "A String", # The search terms for the hold. 276 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 277 # rounded down to the start of the given date. 278 }, 279 }, 280 "corpus": "A String", # The corpus to be searched. 281 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 282} 283 284 x__xgafv: string, V1 error format. 285 Allowed values 286 1 - v1 error format 287 2 - v2 error format 288 289Returns: 290 An object of the form: 291 292 { # Represents a hold within Vault. A hold restricts purging of 293 # artifacts based on the combination of the query and accounts restrictions. 294 # A hold can be configured to either apply to an explicitly configured set 295 # of accounts, or can be applied to all members of an organizational unit. 296 "updateTime": "A String", # The last time this hold was modified. 297 "name": "A String", # The name of the hold. 298 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and 299 # accounts must be empty. This property is mutable. For groups holds, 300 # set the accounts field. 301 # This structure is immutable. 302 "holdTime": "A String", # When the org unit was put on hold. This property is immutable. 303 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. 304 }, 305 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be 306 # empty. 307 { # An account being held in a particular hold. This structure is immutable. 308 # This can be either a single user or a google group, depending on the corpus. 309 "lastName": "A String", # Output only. The last name of the account holder. 310 "holdTime": "A String", # Output only. When the account was put on hold. 311 "email": "A String", # The primary email address of the account. If used as an input, this takes 312 # precedence over account ID. 313 "firstName": "A String", # Output only. The first name of the account holder. 314 "accountId": "A String", # The account's ID as provided by the 315 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 316 }, 317 ], 318 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus 319 # type. 320 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be 321 # Hangouts Chat. 322 "includeRooms": True or False, # If true, include rooms the user has participated in. 323 }, 324 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. 325 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. 326 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. 327 }, 328 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. 329 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 330 # rounded down to the start of the given date. 331 "terms": "A String", # The search terms for the hold. 332 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 333 # rounded down to the start of the given date. 334 }, 335 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. 336 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 337 # rounded down to the start of the given date. 338 "terms": "A String", # The search terms for the hold. 339 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 340 # rounded down to the start of the given date. 341 }, 342 }, 343 "corpus": "A String", # The corpus to be searched. 344 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 345 }</pre> 346</div> 347 348<div class="method"> 349 <code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code> 350 <pre>Removes a hold by ID. This will release any HeldAccounts on this Hold. 351 352Args: 353 matterId: string, The matter ID. (required) 354 holdId: string, The hold ID. (required) 355 x__xgafv: string, V1 error format. 356 Allowed values 357 1 - v1 error format 358 2 - v2 error format 359 360Returns: 361 An object of the form: 362 363 { # A generic empty message that you can re-use to avoid defining duplicated 364 # empty messages in your APIs. A typical example is to use it as the request 365 # or the response type of an API method. For instance: 366 # 367 # service Foo { 368 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 369 # } 370 # 371 # The JSON representation for `Empty` is empty JSON object `{}`. 372 }</pre> 373</div> 374 375<div class="method"> 376 <code class="details" id="get">get(matterId, holdId, x__xgafv=None, view=None)</code> 377 <pre>Gets a hold by ID. 378 379Args: 380 matterId: string, The matter ID. (required) 381 holdId: string, The hold ID. (required) 382 x__xgafv: string, V1 error format. 383 Allowed values 384 1 - v1 error format 385 2 - v2 error format 386 view: string, Specifies which parts of the Hold to return. 387 388Returns: 389 An object of the form: 390 391 { # Represents a hold within Vault. A hold restricts purging of 392 # artifacts based on the combination of the query and accounts restrictions. 393 # A hold can be configured to either apply to an explicitly configured set 394 # of accounts, or can be applied to all members of an organizational unit. 395 "updateTime": "A String", # The last time this hold was modified. 396 "name": "A String", # The name of the hold. 397 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and 398 # accounts must be empty. This property is mutable. For groups holds, 399 # set the accounts field. 400 # This structure is immutable. 401 "holdTime": "A String", # When the org unit was put on hold. This property is immutable. 402 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. 403 }, 404 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be 405 # empty. 406 { # An account being held in a particular hold. This structure is immutable. 407 # This can be either a single user or a google group, depending on the corpus. 408 "lastName": "A String", # Output only. The last name of the account holder. 409 "holdTime": "A String", # Output only. When the account was put on hold. 410 "email": "A String", # The primary email address of the account. If used as an input, this takes 411 # precedence over account ID. 412 "firstName": "A String", # Output only. The first name of the account holder. 413 "accountId": "A String", # The account's ID as provided by the 414 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 415 }, 416 ], 417 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus 418 # type. 419 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be 420 # Hangouts Chat. 421 "includeRooms": True or False, # If true, include rooms the user has participated in. 422 }, 423 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. 424 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. 425 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. 426 }, 427 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. 428 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 429 # rounded down to the start of the given date. 430 "terms": "A String", # The search terms for the hold. 431 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 432 # rounded down to the start of the given date. 433 }, 434 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. 435 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 436 # rounded down to the start of the given date. 437 "terms": "A String", # The search terms for the hold. 438 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 439 # rounded down to the start of the given date. 440 }, 441 }, 442 "corpus": "A String", # The corpus to be searched. 443 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 444 }</pre> 445</div> 446 447<div class="method"> 448 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code> 449 <pre>Lists holds within a matter. An empty page token in ListHoldsResponse 450denotes no more holds to list. 451 452Args: 453 matterId: string, The matter ID. (required) 454 pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive. 455Leaving this empty, or as 0, is the same as page_size = 100. 456 pageToken: string, The pagination token as returned in the response. 457An empty token means start from the beginning. 458 x__xgafv: string, V1 error format. 459 Allowed values 460 1 - v1 error format 461 2 - v2 error format 462 view: string, Specifies which parts of the Hold to return. 463 464Returns: 465 An object of the form: 466 467 { # The holds for a matter. 468 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. 469 # If this is empty, then there are no more holds to list. 470 "holds": [ # The list of holds. 471 { # Represents a hold within Vault. A hold restricts purging of 472 # artifacts based on the combination of the query and accounts restrictions. 473 # A hold can be configured to either apply to an explicitly configured set 474 # of accounts, or can be applied to all members of an organizational unit. 475 "updateTime": "A String", # The last time this hold was modified. 476 "name": "A String", # The name of the hold. 477 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and 478 # accounts must be empty. This property is mutable. For groups holds, 479 # set the accounts field. 480 # This structure is immutable. 481 "holdTime": "A String", # When the org unit was put on hold. This property is immutable. 482 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. 483 }, 484 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be 485 # empty. 486 { # An account being held in a particular hold. This structure is immutable. 487 # This can be either a single user or a google group, depending on the corpus. 488 "lastName": "A String", # Output only. The last name of the account holder. 489 "holdTime": "A String", # Output only. When the account was put on hold. 490 "email": "A String", # The primary email address of the account. If used as an input, this takes 491 # precedence over account ID. 492 "firstName": "A String", # Output only. The first name of the account holder. 493 "accountId": "A String", # The account's ID as provided by the 494 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 495 }, 496 ], 497 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus 498 # type. 499 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be 500 # Hangouts Chat. 501 "includeRooms": True or False, # If true, include rooms the user has participated in. 502 }, 503 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. 504 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. 505 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. 506 }, 507 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. 508 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 509 # rounded down to the start of the given date. 510 "terms": "A String", # The search terms for the hold. 511 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 512 # rounded down to the start of the given date. 513 }, 514 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. 515 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 516 # rounded down to the start of the given date. 517 "terms": "A String", # The search terms for the hold. 518 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 519 # rounded down to the start of the given date. 520 }, 521 }, 522 "corpus": "A String", # The corpus to be searched. 523 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 524 }, 525 ], 526 }</pre> 527</div> 528 529<div class="method"> 530 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 531 <pre>Retrieves the next page of results. 532 533Args: 534 previous_request: The request for the previous page. (required) 535 previous_response: The response from the request for the previous page. (required) 536 537Returns: 538 A request object that you can call 'execute()' on to request the next 539 page. Returns None if there are no more items in the collection. 540 </pre> 541</div> 542 543<div class="method"> 544 <code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body, x__xgafv=None)</code> 545 <pre>Removes HeldAccounts from a hold. Returns a list of statuses in the same 546order as the request. If this request leaves the hold with no held 547accounts, the hold will not apply to any accounts. 548 549Args: 550 matterId: string, The matter ID. (required) 551 holdId: string, The hold ID. (required) 552 body: object, The request body. (required) 553 The object takes the form of: 554 555{ # Remove a list of accounts from a hold. 556 "accountIds": [ # Account ids to identify HeldAccounts to remove. 557 "A String", 558 ], 559 } 560 561 x__xgafv: string, V1 error format. 562 Allowed values 563 1 - v1 error format 564 2 - v2 error format 565 566Returns: 567 An object of the form: 568 569 { # Response for batch delete held accounts. 570 "statuses": [ # A list of statuses for deleted accounts. Results have the 571 # same order as the request. 572 { # The `Status` type defines a logical error model that is suitable for 573 # different programming environments, including REST APIs and RPC APIs. It is 574 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 575 # 576 # - Simple to use and understand for most users 577 # - Flexible enough to meet unexpected needs 578 # 579 # # Overview 580 # 581 # The `Status` message contains three pieces of data: error code, error 582 # message, and error details. The error code should be an enum value of 583 # google.rpc.Code, but it may accept additional error codes if needed. The 584 # error message should be a developer-facing English message that helps 585 # developers *understand* and *resolve* the error. If a localized user-facing 586 # error message is needed, put the localized message in the error details or 587 # localize it in the client. The optional error details may contain arbitrary 588 # information about the error. There is a predefined set of error detail types 589 # in the package `google.rpc` that can be used for common error conditions. 590 # 591 # # Language mapping 592 # 593 # The `Status` message is the logical representation of the error model, but it 594 # is not necessarily the actual wire format. When the `Status` message is 595 # exposed in different client libraries and different wire protocols, it can be 596 # mapped differently. For example, it will likely be mapped to some exceptions 597 # in Java, but more likely mapped to some error codes in C. 598 # 599 # # Other uses 600 # 601 # The error model and the `Status` message can be used in a variety of 602 # environments, either with or without APIs, to provide a 603 # consistent developer experience across different environments. 604 # 605 # Example uses of this error model include: 606 # 607 # - Partial errors. If a service needs to return partial errors to the client, 608 # it may embed the `Status` in the normal response to indicate the partial 609 # errors. 610 # 611 # - Workflow errors. A typical workflow has multiple steps. Each step may 612 # have a `Status` message for error reporting. 613 # 614 # - Batch operations. If a client uses batch request and batch response, the 615 # `Status` message should be used directly inside batch response, one for 616 # each error sub-response. 617 # 618 # - Asynchronous operations. If an API call embeds asynchronous operation 619 # results in its response, the status of those operations should be 620 # represented directly using the `Status` message. 621 # 622 # - Logging. If some API errors are stored in logs, the message `Status` could 623 # be used directly after any stripping needed for security/privacy reasons. 624 "message": "A String", # A developer-facing error message, which should be in English. Any 625 # user-facing error message should be localized and sent in the 626 # google.rpc.Status.details field, or localized by the client. 627 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 628 "details": [ # A list of messages that carry the error details. There is a common set of 629 # message types for APIs to use. 630 { 631 "a_key": "", # Properties of the object. Contains field @type with type URL. 632 }, 633 ], 634 }, 635 ], 636 }</pre> 637</div> 638 639<div class="method"> 640 <code class="details" id="update">update(matterId, holdId, body, x__xgafv=None)</code> 641 <pre>Updates the OU and/or query parameters of a hold. You cannot add accounts 642to a hold that covers an OU, nor can you add OUs to a hold that covers 643individual accounts. Accounts listed in the hold will be ignored. 644 645Args: 646 matterId: string, The matter ID. (required) 647 holdId: string, The ID of the hold. (required) 648 body: object, The request body. (required) 649 The object takes the form of: 650 651{ # Represents a hold within Vault. A hold restricts purging of 652 # artifacts based on the combination of the query and accounts restrictions. 653 # A hold can be configured to either apply to an explicitly configured set 654 # of accounts, or can be applied to all members of an organizational unit. 655 "updateTime": "A String", # The last time this hold was modified. 656 "name": "A String", # The name of the hold. 657 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and 658 # accounts must be empty. This property is mutable. For groups holds, 659 # set the accounts field. 660 # This structure is immutable. 661 "holdTime": "A String", # When the org unit was put on hold. This property is immutable. 662 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. 663 }, 664 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be 665 # empty. 666 { # An account being held in a particular hold. This structure is immutable. 667 # This can be either a single user or a google group, depending on the corpus. 668 "lastName": "A String", # Output only. The last name of the account holder. 669 "holdTime": "A String", # Output only. When the account was put on hold. 670 "email": "A String", # The primary email address of the account. If used as an input, this takes 671 # precedence over account ID. 672 "firstName": "A String", # Output only. The first name of the account holder. 673 "accountId": "A String", # The account's ID as provided by the 674 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 675 }, 676 ], 677 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus 678 # type. 679 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be 680 # Hangouts Chat. 681 "includeRooms": True or False, # If true, include rooms the user has participated in. 682 }, 683 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. 684 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. 685 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. 686 }, 687 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. 688 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 689 # rounded down to the start of the given date. 690 "terms": "A String", # The search terms for the hold. 691 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 692 # rounded down to the start of the given date. 693 }, 694 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. 695 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 696 # rounded down to the start of the given date. 697 "terms": "A String", # The search terms for the hold. 698 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 699 # rounded down to the start of the given date. 700 }, 701 }, 702 "corpus": "A String", # The corpus to be searched. 703 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 704} 705 706 x__xgafv: string, V1 error format. 707 Allowed values 708 1 - v1 error format 709 2 - v2 error format 710 711Returns: 712 An object of the form: 713 714 { # Represents a hold within Vault. A hold restricts purging of 715 # artifacts based on the combination of the query and accounts restrictions. 716 # A hold can be configured to either apply to an explicitly configured set 717 # of accounts, or can be applied to all members of an organizational unit. 718 "updateTime": "A String", # The last time this hold was modified. 719 "name": "A String", # The name of the hold. 720 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and 721 # accounts must be empty. This property is mutable. For groups holds, 722 # set the accounts field. 723 # This structure is immutable. 724 "holdTime": "A String", # When the org unit was put on hold. This property is immutable. 725 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK. 726 }, 727 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be 728 # empty. 729 { # An account being held in a particular hold. This structure is immutable. 730 # This can be either a single user or a google group, depending on the corpus. 731 "lastName": "A String", # Output only. The last name of the account holder. 732 "holdTime": "A String", # Output only. When the account was put on hold. 733 "email": "A String", # The primary email address of the account. If used as an input, this takes 734 # precedence over account ID. 735 "firstName": "A String", # Output only. The first name of the account holder. 736 "accountId": "A String", # The account's ID as provided by the 737 # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. 738 }, 739 ], 740 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus 741 # type. 742 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be 743 # Hangouts Chat. 744 "includeRooms": True or False, # If true, include rooms the user has participated in. 745 }, 746 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive. 747 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold. 748 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold. 749 }, 750 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail. 751 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 752 # rounded down to the start of the given date. 753 "terms": "A String", # The search terms for the hold. 754 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 755 # rounded down to the start of the given date. 756 }, 757 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups. 758 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and 759 # rounded down to the start of the given date. 760 "terms": "A String", # The search terms for the hold. 761 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and 762 # rounded down to the start of the given date. 763 }, 764 }, 765 "corpus": "A String", # The corpus to be searched. 766 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 767 }</pre> 768</div> 769 770</body></html>