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