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">Google 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=None, x__xgafv=None)</a></code></p> 84<p class="firstline">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.</p> 85<p class="toc_element"> 86 <code><a href="#close">close()</a></code></p> 87<p class="firstline">Close httplib2 connections.</p> 88<p class="toc_element"> 89 <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Creates a hold in the specified matter.</p> 91<p class="toc_element"> 92 <code><a href="#delete">delete(matterId, holdId, x__xgafv=None)</a></code></p> 93<p class="firstline">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.</p> 94<p class="toc_element"> 95 <code><a href="#get">get(matterId, holdId, view=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Gets the specified hold.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(matterId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Lists the holds in a matter.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.</p> 106<p class="toc_element"> 107 <code><a href="#update">update(matterId, holdId, body=None, x__xgafv=None)</a></code></p> 108<p class="firstline">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.</p> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code> 112 <pre>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. 113 114Args: 115 matterId: string, The matter ID. (required) 116 holdId: string, The hold ID. (required) 117 body: object, The request body. 118 The object takes the form of: 119 120{ # Add a list of accounts to a hold. 121 "accountIds": [ # 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. 122 "A String", 123 ], 124 "emails": [ # A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both. 125 "A String", 126 ], 127} 128 129 x__xgafv: string, V1 error format. 130 Allowed values 131 1 - v1 error format 132 2 - v2 error format 133 134Returns: 135 An object of the form: 136 137 { # Response for batch create held accounts. 138 "responses": [ # The list of responses, in the same order as the batch request. 139 { # The status of each account creation, and the **HeldAccount**, if successful. 140 "account": { # 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. # Returned when the account was successfully created. 141 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 142 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 143 "firstName": "A String", # Output only. The first name of the account holder. 144 "holdTime": "A String", # Output only. When the account was put on hold. 145 "lastName": "A String", # Output only. The last name of the account holder. 146 }, 147 "status": { # 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). # Reports the request status. If it failed, returns an error message. 148 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 149 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 150 { 151 "a_key": "", # Properties of the object. Contains field @type with type URL. 152 }, 153 ], 154 "message": "A String", # 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. 155 }, 156 }, 157 ], 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="close">close()</code> 163 <pre>Close httplib2 connections.</pre> 164</div> 165 166<div class="method"> 167 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code> 168 <pre>Creates a hold in the specified matter. 169 170Args: 171 matterId: string, The matter ID. (required) 172 body: object, The request body. 173 The object takes the form of: 174 175{ # 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. 176 "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty. 177 { # 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. 178 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 179 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 180 "firstName": "A String", # Output only. The first name of the account holder. 181 "holdTime": "A String", # Output only. When the account was put on hold. 182 "lastName": "A String", # Output only. The last name of the account holder. 183 }, 184 ], 185 "corpus": "A String", # The service to be searched. 186 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 187 "name": "A String", # The name of the hold. 188 "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**. 189 "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable. 190 "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 191 }, 192 "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**. 193 "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**. 194 "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**. 195 "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**. 196 }, 197 "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**. 198 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 199 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 200 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 201 }, 202 "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**. 203 "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**. 204 }, 205 "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**. 206 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 207 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 208 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 209 }, 210 "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**. 211 "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored. 212 "A String", 213 ], 214 }, 215 }, 216 "updateTime": "A String", # The last time this hold was modified. 217} 218 219 x__xgafv: string, V1 error format. 220 Allowed values 221 1 - v1 error format 222 2 - v2 error format 223 224Returns: 225 An object of the form: 226 227 { # 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. 228 "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty. 229 { # 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. 230 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 231 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 232 "firstName": "A String", # Output only. The first name of the account holder. 233 "holdTime": "A String", # Output only. When the account was put on hold. 234 "lastName": "A String", # Output only. The last name of the account holder. 235 }, 236 ], 237 "corpus": "A String", # The service to be searched. 238 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 239 "name": "A String", # The name of the hold. 240 "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**. 241 "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable. 242 "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 243 }, 244 "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**. 245 "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**. 246 "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**. 247 "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**. 248 }, 249 "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**. 250 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 251 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 252 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 253 }, 254 "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**. 255 "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**. 256 }, 257 "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**. 258 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 259 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 260 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 261 }, 262 "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**. 263 "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored. 264 "A String", 265 ], 266 }, 267 }, 268 "updateTime": "A String", # The last time this hold was modified. 269}</pre> 270</div> 271 272<div class="method"> 273 <code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code> 274 <pre>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. 275 276Args: 277 matterId: string, The matter ID. (required) 278 holdId: string, The hold ID. (required) 279 x__xgafv: string, V1 error format. 280 Allowed values 281 1 - v1 error format 282 2 - v2 error format 283 284Returns: 285 An object of the form: 286 287 { # 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 `{}`. 288}</pre> 289</div> 290 291<div class="method"> 292 <code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code> 293 <pre>Gets the specified hold. 294 295Args: 296 matterId: string, The matter ID. (required) 297 holdId: string, The hold ID. (required) 298 view: string, The amount of detail to return for a hold. 299 Allowed values 300 HOLD_VIEW_UNSPECIFIED - Not specified. Defaults to **FULL_HOLD**. 301 BASIC_HOLD - Returns the hold ID, name, update time, service, and query. 302 FULL_HOLD - Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit. 303 x__xgafv: string, V1 error format. 304 Allowed values 305 1 - v1 error format 306 2 - v2 error format 307 308Returns: 309 An object of the form: 310 311 { # 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. 312 "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty. 313 { # 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. 314 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 315 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 316 "firstName": "A String", # Output only. The first name of the account holder. 317 "holdTime": "A String", # Output only. When the account was put on hold. 318 "lastName": "A String", # Output only. The last name of the account holder. 319 }, 320 ], 321 "corpus": "A String", # The service to be searched. 322 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 323 "name": "A String", # The name of the hold. 324 "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**. 325 "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable. 326 "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 327 }, 328 "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**. 329 "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**. 330 "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**. 331 "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**. 332 }, 333 "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**. 334 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 335 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 336 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 337 }, 338 "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**. 339 "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**. 340 }, 341 "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**. 342 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 343 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 344 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 345 }, 346 "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**. 347 "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored. 348 "A String", 349 ], 350 }, 351 }, 352 "updateTime": "A String", # The last time this hold was modified. 353}</pre> 354</div> 355 356<div class="method"> 357 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 358 <pre>Lists the holds in a matter. 359 360Args: 361 matterId: string, The matter ID. (required) 362 pageSize: integer, 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. 363 pageToken: string, The pagination token as returned in the response. An empty token means start from the beginning. 364 view: string, The amount of detail to return for a hold. 365 Allowed values 366 HOLD_VIEW_UNSPECIFIED - Not specified. Defaults to **FULL_HOLD**. 367 BASIC_HOLD - Returns the hold ID, name, update time, service, and query. 368 FULL_HOLD - Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit. 369 x__xgafv: string, V1 error format. 370 Allowed values 371 1 - v1 error format 372 2 - v2 error format 373 374Returns: 375 An object of the form: 376 377 { # The holds for a matter. 378 "holds": [ # The list of holds. 379 { # 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. 380 "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty. 381 { # 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. 382 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 383 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 384 "firstName": "A String", # Output only. The first name of the account holder. 385 "holdTime": "A String", # Output only. When the account was put on hold. 386 "lastName": "A String", # Output only. The last name of the account holder. 387 }, 388 ], 389 "corpus": "A String", # The service to be searched. 390 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 391 "name": "A String", # The name of the hold. 392 "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**. 393 "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable. 394 "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 395 }, 396 "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**. 397 "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**. 398 "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**. 399 "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**. 400 }, 401 "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**. 402 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 403 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 404 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 405 }, 406 "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**. 407 "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**. 408 }, 409 "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**. 410 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 411 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 412 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 413 }, 414 "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**. 415 "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored. 416 "A String", 417 ], 418 }, 419 }, 420 "updateTime": "A String", # The last time this hold was modified. 421 }, 422 ], 423 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list. 424}</pre> 425</div> 426 427<div class="method"> 428 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 429 <pre>Retrieves the next page of results. 430 431Args: 432 previous_request: The request for the previous page. (required) 433 previous_response: The response from the request for the previous page. (required) 434 435Returns: 436 A request object that you can call 'execute()' on to request the next 437 page. Returns None if there are no more items in the collection. 438 </pre> 439</div> 440 441<div class="method"> 442 <code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code> 443 <pre>Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request. 444 445Args: 446 matterId: string, The matter ID. (required) 447 holdId: string, The hold ID. (required) 448 body: object, The request body. 449 The object takes the form of: 450 451{ # Remove a list of accounts from a hold. 452 "accountIds": [ # The account IDs of the accounts to remove from the hold. 453 "A String", 454 ], 455} 456 457 x__xgafv: string, V1 error format. 458 Allowed values 459 1 - v1 error format 460 2 - v2 error format 461 462Returns: 463 An object of the form: 464 465 { # Response for batch delete held accounts. 466 "statuses": [ # A list of statuses for the deleted accounts. Results have the same order as the request. 467 { # 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). 468 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 469 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 470 { 471 "a_key": "", # Properties of the object. Contains field @type with type URL. 472 }, 473 ], 474 "message": "A String", # 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. 475 }, 476 ], 477}</pre> 478</div> 479 480<div class="method"> 481 <code class="details" id="update">update(matterId, holdId, body=None, x__xgafv=None)</code> 482 <pre>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. 483 484Args: 485 matterId: string, The matter ID. (required) 486 holdId: string, The ID of the hold. (required) 487 body: object, The request body. 488 The object takes the form of: 489 490{ # 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. 491 "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty. 492 { # 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. 493 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 494 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 495 "firstName": "A String", # Output only. The first name of the account holder. 496 "holdTime": "A String", # Output only. When the account was put on hold. 497 "lastName": "A String", # Output only. The last name of the account holder. 498 }, 499 ], 500 "corpus": "A String", # The service to be searched. 501 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 502 "name": "A String", # The name of the hold. 503 "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**. 504 "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable. 505 "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 506 }, 507 "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**. 508 "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**. 509 "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**. 510 "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**. 511 }, 512 "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**. 513 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 514 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 515 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 516 }, 517 "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**. 518 "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**. 519 }, 520 "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**. 521 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 522 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 523 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 524 }, 525 "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**. 526 "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored. 527 "A String", 528 ], 529 }, 530 }, 531 "updateTime": "A String", # The last time this hold was modified. 532} 533 534 x__xgafv: string, V1 error format. 535 Allowed values 536 1 - v1 error format 537 2 - v2 error format 538 539Returns: 540 An object of the form: 541 542 { # 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. 543 "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty. 544 { # 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. 545 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 546 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 547 "firstName": "A String", # Output only. The first name of the account holder. 548 "holdTime": "A String", # Output only. When the account was put on hold. 549 "lastName": "A String", # Output only. The last name of the account holder. 550 }, 551 ], 552 "corpus": "A String", # The service to be searched. 553 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation. 554 "name": "A String", # The name of the hold. 555 "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**. 556 "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable. 557 "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 558 }, 559 "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**. 560 "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**. 561 "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**. 562 "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**. 563 }, 564 "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**. 565 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 566 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 567 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 568 }, 569 "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**. 570 "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**. 571 }, 572 "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**. 573 "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 574 "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date. 575 "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold. 576 }, 577 "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**. 578 "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored. 579 "A String", 580 ], 581 }, 582 }, 583 "updateTime": "A String", # The last time this hold was modified. 584}</pre> 585</div> 586 587</body></html>