blob: 513860b38d72ddd9b403cef3fa814596ebbe7ef4 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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 -070083 <code><a href="#addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084<p class="firstline">Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added 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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070089 <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090<p class="firstline">Creates a hold in the given 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 a hold by ID. This will release any HeldAccounts on this Hold.</p>
94<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070095 <code><a href="#get">get(matterId, holdId, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096<p class="firstline">Gets a hold by ID.</p>
97<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070098 <code><a href="#list">list(matterId, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070099<p class="firstline">Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 <code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105<p class="firstline">Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code><a href="#update">update(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108<p class="firstline">Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<h3>Method Details</h3>
110<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 <pre>Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113
114Args:
115 matterId: string, The matter ID. (required)
116 holdId: string, The hold ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700117 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118 The object takes the form of:
119
120{ # Add a list of accounts to a hold.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700121 &quot;emails&quot;: [ # Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 &quot;A String&quot;,
123 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700124 &quot;accountIds&quot;: [ # Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
Bu Sun Kim65020912020-05-20 12:08:20 -0700125 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700126 ],
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700138 &quot;responses&quot;: [ # The list of responses, in the same order as the batch request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700139 { # A status detailing the status of each account creation, and the HeldAccount, if successful.
140 &quot;status&quot;: { # 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). # This represents the success status. If failed, check message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700141 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
142 &quot;message&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700143 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700144 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700146 },
147 ],
148 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149 &quot;account&quot;: { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. # If present, this account was successfully created.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700150 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700151 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700152 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700153 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700154 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700155 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700156 },
157 ],
158 }</pre>
159</div>
160
161<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700162 <code class="details" id="close">close()</code>
163 <pre>Close httplib2 connections.</pre>
164</div>
165
166<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700167 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700168 <pre>Creates a hold in the given matter.
169
170Args:
171 matterId: string, The matter ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700172 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700173 The object takes the form of:
174
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700175{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700176 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
177 { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
178 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
179 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
180 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
181 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
182 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
183 },
184 ],
185 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
186 &quot;orgUnit&quot;: { # A organizational unit being held in a particular 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 the accounts field.
187 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
188 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700189 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700190 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
191 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
192 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
193 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
194 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
195 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
196 },
197 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
198 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
199 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
200 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
201 },
202 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
203 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
204 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
205 },
206 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
207 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
208 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
209 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
210 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700211 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700212 }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700213
214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219Returns:
220 An object of the form:
221
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700222 { # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700223 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
224 { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
225 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
226 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
227 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
228 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
229 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
230 },
231 ],
232 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
233 &quot;orgUnit&quot;: { # A organizational unit being held in a particular 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 the accounts field.
234 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
235 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700236 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700237 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
238 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
239 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
240 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
241 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
242 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
243 },
244 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
245 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
246 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
247 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
248 },
249 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
250 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
251 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
252 },
253 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
254 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
255 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
256 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
257 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700258 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700259 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700260</div>
261
262<div class="method">
263 <code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code>
264 <pre>Removes a hold by ID. This will release any HeldAccounts on this Hold.
265
266Args:
267 matterId: string, The matter ID. (required)
268 holdId: string, The hold ID. (required)
269 x__xgafv: string, V1 error format.
270 Allowed values
271 1 - v1 error format
272 2 - v2 error format
273
274Returns:
275 An object of the form:
276
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700277 { # 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 `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700278 }</pre>
279</div>
280
281<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700282 <code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700283 <pre>Gets a hold by ID.
284
285Args:
286 matterId: string, The matter ID. (required)
287 holdId: string, The hold ID. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700288 view: string, Specifies which parts of the Hold to return.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700289 Allowed values
290 HOLD_VIEW_UNSPECIFIED - There is no specified view. Defaults to FULL_HOLD.
291 BASIC_HOLD - Response includes the id, name, update time, corpus, and query.
292 FULL_HOLD - Full representation of a Hold. Response includes all fields of &#x27;BASIC&#x27; and the entities the Hold applies to, such as accounts, or OU.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700293 x__xgafv: string, V1 error format.
294 Allowed values
295 1 - v1 error format
296 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700297
298Returns:
299 An object of the form:
300
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700301 { # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700302 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
303 { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
304 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
305 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
306 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
307 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
308 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
309 },
310 ],
311 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
312 &quot;orgUnit&quot;: { # A organizational unit being held in a particular 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 the accounts field.
313 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
314 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700315 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700316 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
317 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
318 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
319 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
320 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
321 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
322 },
323 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
324 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
325 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
326 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
327 },
328 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
329 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
330 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
331 },
332 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
333 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
334 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
335 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
336 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700337 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700338 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700339</div>
340
341<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700342 <code class="details" id="list">list(matterId, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700343 <pre>Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700344
345Args:
346 matterId: string, The matter ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700347 pageToken: string, The pagination token as returned in the response. An empty token means start from the beginning.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700348 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700349 view: string, Specifies which parts of the Hold to return.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700350 Allowed values
351 HOLD_VIEW_UNSPECIFIED - There is no specified view. Defaults to FULL_HOLD.
352 BASIC_HOLD - Response includes the id, name, update time, corpus, and query.
353 FULL_HOLD - Full representation of a Hold. Response includes all fields of &#x27;BASIC&#x27; and the entities the Hold applies to, such as accounts, or OU.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700354 x__xgafv: string, V1 error format.
355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358
359Returns:
360 An object of the form:
361
362 { # The holds for a matter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700363 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700364 &quot;holds&quot;: [ # The list of holds.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700365 { # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700366 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
367 { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
368 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
369 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
370 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
371 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
372 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
373 },
374 ],
375 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
376 &quot;orgUnit&quot;: { # A organizational unit being held in a particular 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 the accounts field.
377 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
378 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700379 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700380 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
381 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
382 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
383 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
384 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
385 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
386 },
387 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
388 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
389 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
390 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
391 },
392 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
393 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
394 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
395 },
396 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
397 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
398 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
399 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
400 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700401 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700402 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700403 ],
404 }</pre>
405</div>
406
407<div class="method">
408 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
409 <pre>Retrieves the next page of results.
410
411Args:
412 previous_request: The request for the previous page. (required)
413 previous_response: The response from the request for the previous page. (required)
414
415Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700416 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700417 page. Returns None if there are no more items in the collection.
418 </pre>
419</div>
420
421<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700422 <code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700423 <pre>Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700424
425Args:
426 matterId: string, The matter ID. (required)
427 holdId: string, The hold ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700428 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700429 The object takes the form of:
430
431{ # Remove a list of accounts from a hold.
Bu Sun Kim65020912020-05-20 12:08:20 -0700432 &quot;accountIds&quot;: [ # Account IDs to identify HeldAccounts to remove.
433 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 ],
435 }
436
437 x__xgafv: string, V1 error format.
438 Allowed values
439 1 - v1 error format
440 2 - v2 error format
441
442Returns:
443 An object of the form:
444
445 { # Response for batch delete held accounts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700446 &quot;statuses&quot;: [ # A list of statuses for deleted accounts. Results have the same order as the request.
447 { # 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700448 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
449 &quot;message&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700450 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700452 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700453 },
454 ],
455 },
456 ],
457 }</pre>
458</div>
459
460<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700461 <code class="details" id="update">update(matterId, holdId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700462 <pre>Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700463
464Args:
465 matterId: string, The matter ID. (required)
466 holdId: string, The ID of the hold. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700467 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700468 The object takes the form of:
469
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700470{ # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700471 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
472 { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
473 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
474 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
475 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
476 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
477 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
478 },
479 ],
480 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
481 &quot;orgUnit&quot;: { # A organizational unit being held in a particular 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 the accounts field.
482 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
483 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700484 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700485 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
486 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
487 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
488 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
489 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
490 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
491 },
492 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
493 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
494 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
495 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
496 },
497 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
498 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
499 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
500 },
501 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
502 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
503 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
504 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
505 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700506 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700507 }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700508
509 x__xgafv: string, V1 error format.
510 Allowed values
511 1 - v1 error format
512 2 - v2 error format
513
514Returns:
515 An object of the form:
516
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700517 { # Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700518 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
519 { # An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
520 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
521 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over account ID.
522 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
523 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
524 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the Admin SDK.
525 },
526 ],
527 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
528 &quot;orgUnit&quot;: { # A organizational unit being held in a particular 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 the accounts field.
529 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
530 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700531 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700532 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
533 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
534 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
535 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
536 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
537 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
538 },
539 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
540 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
541 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
542 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
543 },
544 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
545 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
546 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
547 },
548 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
549 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
550 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
551 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
552 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700553 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700554 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700555</div>
556
557</body></html>