Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / vault_v1.matters.holds.html
blob: fd9231261fd490351b4b588056c8e3da8efcf8f5 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="#addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Adds HeldAccounts to a hold. Returns a list of accounts that have been</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]86 <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 <code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102<p class="firstline">Removes HeldAccounts from a hold. Returns a list of statuses in the same</p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104 <code><a href="#update">update(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 The object takes the form of:
118
119{ # Add a list of accounts to a hold.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120 "accountIds": [ # Account IDs to identify which accounts to add. Only account_ids or only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
145 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 # You can find out more about this error model and how to work with it in the
148 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 "message": "A String", # A developer-facing error message, which should be in English. Any
150 # user-facing error message should be localized and sent in the
151 # google.rpc.Status.details field, or localized by the client.
152 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
153 "details": [ # A list of messages that carry the error details. There is a common set of
154 # message types for APIs to use.
155 {
156 "a_key": "", # Properties of the object. Contains field @type with type URL.
157 },
158 ],
159 },
160 "account": { # An account being held in a particular hold. This structure is immutable. # If present, this account was successfully created.
161 # This can be either a single user or a google group, depending on the corpus.
162 "lastName": "A String", # Output only. The last name of the account holder.
163 "holdTime": "A String", # Output only. When the account was put on hold.
164 "email": "A String", # The primary email address of the account. If used as an input, this takes
165 # precedence over account ID.
166 "firstName": "A String", # Output only. The first name of the account holder.
167 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 },
170 },
171 ],
172 }</pre>
173</div>
174
175<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]176 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 <pre>Creates a hold in the given matter.
178
179Args:
180 matterId: string, The matter ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]181 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 The object takes the form of:
183
184{ # Represents a hold within Vault. A hold restricts purging of
185 # artifacts based on the combination of the query and accounts restrictions.
186 # A hold can be configured to either apply to an explicitly configured set
187 # of accounts, or can be applied to all members of an organizational unit.
188 "updateTime": "A String", # The last time this hold was modified.
189 "name": "A String", # The name of the hold.
190 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
191 # accounts must be empty. This property is mutable. For groups holds,
192 # set the accounts field.
193 # This structure is immutable.
194 "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
195 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
196 },
197 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
198 # empty.
199 { # An account being held in a particular hold. This structure is immutable.
200 # This can be either a single user or a google group, depending on the corpus.
201 "lastName": "A String", # Output only. The last name of the account holder.
202 "holdTime": "A String", # Output only. When the account was put on hold.
203 "email": "A String", # The primary email address of the account. If used as an input, this takes
204 # precedence over account ID.
205 "firstName": "A String", # Output only. The first name of the account holder.
206 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]207 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 },
209 ],
210 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
211 # type.
212 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
213 # Hangouts Chat.
214 "includeRooms": True or False, # If true, include rooms the user has participated in.
215 },
216 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
217 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
218 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
219 },
220 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
221 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
222 # rounded down to the start of the given date.
223 "terms": "A String", # The search terms for the hold.
224 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
225 # rounded down to the start of the given date.
226 },
227 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
228 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
229 # rounded down to the start of the given date.
230 "terms": "A String", # The search terms for the hold.
231 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
232 # rounded down to the start of the given date.
233 },
234 },
235 "corpus": "A String", # The corpus to be searched.
236 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
237}
238
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244Returns:
245 An object of the form:
246
247 { # Represents a hold within Vault. A hold restricts purging of
248 # artifacts based on the combination of the query and accounts restrictions.
249 # A hold can be configured to either apply to an explicitly configured set
250 # of accounts, or can be applied to all members of an organizational unit.
251 "updateTime": "A String", # The last time this hold was modified.
252 "name": "A String", # The name of the hold.
253 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
254 # accounts must be empty. This property is mutable. For groups holds,
255 # set the accounts field.
256 # This structure is immutable.
257 "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
258 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
259 },
260 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
261 # empty.
262 { # An account being held in a particular hold. This structure is immutable.
263 # This can be either a single user or a google group, depending on the corpus.
264 "lastName": "A String", # Output only. The last name of the account holder.
265 "holdTime": "A String", # Output only. When the account was put on hold.
266 "email": "A String", # The primary email address of the account. If used as an input, this takes
267 # precedence over account ID.
268 "firstName": "A String", # Output only. The first name of the account holder.
269 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]270 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 },
272 ],
273 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
274 # type.
275 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
276 # Hangouts Chat.
277 "includeRooms": True or False, # If true, include rooms the user has participated in.
278 },
279 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
280 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
281 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
282 },
283 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
284 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
285 # rounded down to the start of the given date.
286 "terms": "A String", # The search terms for the hold.
287 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
288 # rounded down to the start of the given date.
289 },
290 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
291 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
292 # rounded down to the start of the given date.
293 "terms": "A String", # The search terms for the hold.
294 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
295 # rounded down to the start of the given date.
296 },
297 },
298 "corpus": "A String", # The corpus to be searched.
299 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
300 }</pre>
301</div>
302
303<div class="method">
304 <code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code>
305 <pre>Removes a hold by ID. This will release any HeldAccounts on this Hold.
306
307Args:
308 matterId: string, The matter ID. (required)
309 holdId: string, The hold ID. (required)
310 x__xgafv: string, V1 error format.
311 Allowed values
312 1 - v1 error format
313 2 - v2 error format
314
315Returns:
316 An object of the form:
317
318 { # A generic empty message that you can re-use to avoid defining duplicated
319 # empty messages in your APIs. A typical example is to use it as the request
320 # or the response type of an API method. For instance:
321 #
322 # service Foo {
323 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
324 # }
325 #
326 # The JSON representation for `Empty` is empty JSON object `{}`.
327 }</pre>
328</div>
329
330<div class="method">
331 <code class="details" id="get">get(matterId, holdId, x__xgafv=None, view=None)</code>
332 <pre>Gets a hold by ID.
333
334Args:
335 matterId: string, The matter ID. (required)
336 holdId: string, The hold ID. (required)
337 x__xgafv: string, V1 error format.
338 Allowed values
339 1 - v1 error format
340 2 - v2 error format
341 view: string, Specifies which parts of the Hold to return.
342
343Returns:
344 An object of the form:
345
346 { # Represents a hold within Vault. A hold restricts purging of
347 # artifacts based on the combination of the query and accounts restrictions.
348 # A hold can be configured to either apply to an explicitly configured set
349 # of accounts, or can be applied to all members of an organizational unit.
350 "updateTime": "A String", # The last time this hold was modified.
351 "name": "A String", # The name of the hold.
352 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
353 # accounts must be empty. This property is mutable. For groups holds,
354 # set the accounts field.
355 # This structure is immutable.
356 "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
357 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
358 },
359 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
360 # empty.
361 { # An account being held in a particular hold. This structure is immutable.
362 # This can be either a single user or a google group, depending on the corpus.
363 "lastName": "A String", # Output only. The last name of the account holder.
364 "holdTime": "A String", # Output only. When the account was put on hold.
365 "email": "A String", # The primary email address of the account. If used as an input, this takes
366 # precedence over account ID.
367 "firstName": "A String", # Output only. The first name of the account holder.
368 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]369 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 },
371 ],
372 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
373 # type.
374 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
375 # Hangouts Chat.
376 "includeRooms": True or False, # If true, include rooms the user has participated in.
377 },
378 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
379 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
380 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
381 },
382 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
383 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
384 # rounded down to the start of the given date.
385 "terms": "A String", # The search terms for the hold.
386 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
387 # rounded down to the start of the given date.
388 },
389 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
390 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
391 # rounded down to the start of the given date.
392 "terms": "A String", # The search terms for the hold.
393 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
394 # rounded down to the start of the given date.
395 },
396 },
397 "corpus": "A String", # The corpus to be searched.
398 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
399 }</pre>
400</div>
401
402<div class="method">
403 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code>
404 <pre>Lists holds within a matter. An empty page token in ListHoldsResponse
405denotes no more holds to list.
406
407Args:
408 matterId: string, The matter ID. (required)
409 pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive.
410Leaving this empty, or as 0, is the same as page_size = 100.
411 pageToken: string, The pagination token as returned in the response.
412An empty token means start from the beginning.
413 x__xgafv: string, V1 error format.
414 Allowed values
415 1 - v1 error format
416 2 - v2 error format
417 view: string, Specifies which parts of the Hold to return.
418
419Returns:
420 An object of the form:
421
422 { # The holds for a matter.
423 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
424 # If this is empty, then there are no more holds to list.
425 "holds": [ # The list of holds.
426 { # Represents a hold within Vault. A hold restricts purging of
427 # artifacts based on the combination of the query and accounts restrictions.
428 # A hold can be configured to either apply to an explicitly configured set
429 # of accounts, or can be applied to all members of an organizational unit.
430 "updateTime": "A String", # The last time this hold was modified.
431 "name": "A String", # The name of the hold.
432 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
433 # accounts must be empty. This property is mutable. For groups holds,
434 # set the accounts field.
435 # This structure is immutable.
436 "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
437 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
438 },
439 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
440 # empty.
441 { # An account being held in a particular hold. This structure is immutable.
442 # This can be either a single user or a google group, depending on the corpus.
443 "lastName": "A String", # Output only. The last name of the account holder.
444 "holdTime": "A String", # Output only. When the account was put on hold.
445 "email": "A String", # The primary email address of the account. If used as an input, this takes
446 # precedence over account ID.
447 "firstName": "A String", # Output only. The first name of the account holder.
448 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]449 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 },
451 ],
452 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
453 # type.
454 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
455 # Hangouts Chat.
456 "includeRooms": True or False, # If true, include rooms the user has participated in.
457 },
458 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
459 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
460 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
461 },
462 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
463 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
464 # rounded down to the start of the given date.
465 "terms": "A String", # The search terms for the hold.
466 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
467 # rounded down to the start of the given date.
468 },
469 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
470 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
471 # rounded down to the start of the given date.
472 "terms": "A String", # The search terms for the hold.
473 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
474 # rounded down to the start of the given date.
475 },
476 },
477 "corpus": "A String", # The corpus to be searched.
478 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
479 },
480 ],
481 }</pre>
482</div>
483
484<div class="method">
485 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
486 <pre>Retrieves the next page of results.
487
488Args:
489 previous_request: The request for the previous page. (required)
490 previous_response: The response from the request for the previous page. (required)
491
492Returns:
493 A request object that you can call 'execute()' on to request the next
494 page. Returns None if there are no more items in the collection.
495 </pre>
496</div>
497
498<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]499 <code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 <pre>Removes HeldAccounts from a hold. Returns a list of statuses in the same
501order as the request. If this request leaves the hold with no held
502accounts, the hold will not apply to any accounts.
503
504Args:
505 matterId: string, The matter ID. (required)
506 holdId: string, The hold ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]507 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 The object takes the form of:
509
510{ # Remove a list of accounts from a hold.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]511 "accountIds": [ # Account IDs to identify HeldAccounts to remove.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512 "A String",
513 ],
514 }
515
516 x__xgafv: string, V1 error format.
517 Allowed values
518 1 - v1 error format
519 2 - v2 error format
520
521Returns:
522 An object of the form:
523
524 { # Response for batch delete held accounts.
525 "statuses": [ # A list of statuses for deleted accounts. Results have the
526 # same order as the request.
527 { # The `Status` type defines a logical error model that is suitable for
528 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]529 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
530 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]531 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]532 # You can find out more about this error model and how to work with it in the
533 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 "message": "A String", # A developer-facing error message, which should be in English. Any
535 # user-facing error message should be localized and sent in the
536 # google.rpc.Status.details field, or localized by the client.
537 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
538 "details": [ # A list of messages that carry the error details. There is a common set of
539 # message types for APIs to use.
540 {
541 "a_key": "", # Properties of the object. Contains field @type with type URL.
542 },
543 ],
544 },
545 ],
546 }</pre>
547</div>
548
549<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]550 <code class="details" id="update">update(matterId, holdId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 <pre>Updates the OU and/or query parameters of a hold. You cannot add accounts
552to a hold that covers an OU, nor can you add OUs to a hold that covers
553individual accounts. Accounts listed in the hold will be ignored.
554
555Args:
556 matterId: string, The matter ID. (required)
557 holdId: string, The ID of the hold. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]558 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]559 The object takes the form of:
560
561{ # Represents a hold within Vault. A hold restricts purging of
562 # artifacts based on the combination of the query and accounts restrictions.
563 # A hold can be configured to either apply to an explicitly configured set
564 # of accounts, or can be applied to all members of an organizational unit.
565 "updateTime": "A String", # The last time this hold was modified.
566 "name": "A String", # The name of the hold.
567 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
568 # accounts must be empty. This property is mutable. For groups holds,
569 # set the accounts field.
570 # This structure is immutable.
571 "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
572 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
573 },
574 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
575 # empty.
576 { # An account being held in a particular hold. This structure is immutable.
577 # This can be either a single user or a google group, depending on the corpus.
578 "lastName": "A String", # Output only. The last name of the account holder.
579 "holdTime": "A String", # Output only. When the account was put on hold.
580 "email": "A String", # The primary email address of the account. If used as an input, this takes
581 # precedence over account ID.
582 "firstName": "A String", # Output only. The first name of the account holder.
583 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]584 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 },
586 ],
587 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
588 # type.
589 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
590 # Hangouts Chat.
591 "includeRooms": True or False, # If true, include rooms the user has participated in.
592 },
593 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
594 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
595 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
596 },
597 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
598 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
599 # rounded down to the start of the given date.
600 "terms": "A String", # The search terms for the hold.
601 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
602 # rounded down to the start of the given date.
603 },
604 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
605 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
606 # rounded down to the start of the given date.
607 "terms": "A String", # The search terms for the hold.
608 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
609 # rounded down to the start of the given date.
610 },
611 },
612 "corpus": "A String", # The corpus to be searched.
613 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
614}
615
616 x__xgafv: string, V1 error format.
617 Allowed values
618 1 - v1 error format
619 2 - v2 error format
620
621Returns:
622 An object of the form:
623
624 { # Represents a hold within Vault. A hold restricts purging of
625 # artifacts based on the combination of the query and accounts restrictions.
626 # A hold can be configured to either apply to an explicitly configured set
627 # of accounts, or can be applied to all members of an organizational unit.
628 "updateTime": "A String", # The last time this hold was modified.
629 "name": "A String", # The name of the hold.
630 "orgUnit": { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
631 # accounts must be empty. This property is mutable. For groups holds,
632 # set the accounts field.
633 # This structure is immutable.
634 "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
635 "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
636 },
637 "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
638 # empty.
639 { # An account being held in a particular hold. This structure is immutable.
640 # This can be either a single user or a google group, depending on the corpus.
641 "lastName": "A String", # Output only. The last name of the account holder.
642 "holdTime": "A String", # Output only. When the account was put on hold.
643 "email": "A String", # The primary email address of the account. If used as an input, this takes
644 # precedence over account ID.
645 "firstName": "A String", # Output only. The first name of the account holder.
646 "accountId": "A String", # The account's ID as provided by the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]647 # &lt;a href="https://developers.google.com/admin-sdk/"&gt;Admin SDK&lt;/a&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]648 },
649 ],
650 "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
651 # type.
652 "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
653 # Hangouts Chat.
654 "includeRooms": True or False, # If true, include rooms the user has participated in.
655 },
656 "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
657 "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
658 "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
659 },
660 "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
661 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
662 # rounded down to the start of the given date.
663 "terms": "A String", # The search terms for the hold.
664 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
665 # rounded down to the start of the given date.
666 },
667 "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
668 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
669 # rounded down to the start of the given date.
670 "terms": "A String", # The search terms for the hold.
671 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
672 # rounded down to the start of the given date.
673 },
674 },
675 "corpus": "A String", # The corpus to be searched.
676 "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
677 }</pre>
678</div>
679
680</body></html>