Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / vault_v1.matters.holds.html
blob: dc2d04cb0aa70990543c61fa132cba287a80c55c [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 <code><a href="#get">get(matterId, holdId, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93<p class="firstline">Gets a hold by ID.</p>
94<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]95 <code><a href="#list">list(matterId, view=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;emails&quot;: [ # Emails to identify which accounts to add. Only emails or only account_ids
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 # should be specified, but not both.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &quot;A String&quot;,
123 ],
124 &quot;accountIds&quot;: [ # Account IDs to identify which accounts to add. Only account_ids or only
125 # emails should be specified, but not both.
126 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;responses&quot;: [ # The list of responses, in the same order as the batch request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 { # A status detailing the status of each account creation, and the
141 # HeldAccount, if successful.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # This represents the success status. If failed, check message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]149 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 # message types for APIs to use.
152 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 },
155 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
157 # user-facing error message should be localized and sent in the
158 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]160 &quot;account&quot;: { # 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 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
163 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
164 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
165 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
166 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
167 # precedence over account ID.
168 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
169 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]188 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &quot;orgUnit&quot;: { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
190 # accounts must be empty. This property is mutable. For groups holds,
191 # set the accounts field.
192 # This structure is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]193 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]194 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]195 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]196 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
197 # empty.
198 { # An account being held in a particular hold. This structure is immutable.
199 # This can be either a single user or a google group, depending on the corpus.
200 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
201 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
202 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
203 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
204 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
205 # precedence over account ID.
206 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
207 },
208 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
212 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
213 # rounded down to the start of the given date.
214 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
215 # rounded down to the start of the given date.
216 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
217 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]218 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
219 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
220 # rounded down to the start of the given date.
221 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
224 },
225 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
226 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
227 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
228 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]234 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
236 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]251 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]252 &quot;orgUnit&quot;: { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
253 # accounts must be empty. This property is mutable. For groups holds,
254 # set the accounts field.
255 # This structure is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]256 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]257 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]258 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]259 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
260 # empty.
261 { # An account being held in a particular hold. This structure is immutable.
262 # This can be either a single user or a google group, depending on the corpus.
263 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
264 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
265 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
266 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
267 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
268 # precedence over account ID.
269 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
270 },
271 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]272 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
273 # type.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]274 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
275 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
276 # rounded down to the start of the given date.
277 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
278 # rounded down to the start of the given date.
279 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
280 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]281 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
282 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
283 # rounded down to the start of the given date.
284 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
287 },
288 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
289 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
290 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
291 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]292 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
293 # Hangouts Chat.
294 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
295 },
296 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]297 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]298 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
299 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]300 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]331 <code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332 <pre>Gets a hold by ID.
333
334Args:
335 matterId: string, The matter ID. (required)
336 holdId: string, The hold ID. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]337 view: string, Specifies which parts of the Hold to return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 x__xgafv: string, V1 error format.
339 Allowed values
340 1 - v1 error format
341 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342
343Returns:
344 An object of the form:
345
346 { # Represents a hold within Vault. A hold restricts purging of
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]350 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]351 &quot;orgUnit&quot;: { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
352 # accounts must be empty. This property is mutable. For groups holds,
353 # set the accounts field.
354 # This structure is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]355 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]356 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]358 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
359 # empty.
360 { # An account being held in a particular hold. This structure is immutable.
361 # This can be either a single user or a google group, depending on the corpus.
362 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
363 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
364 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
365 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
366 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
367 # precedence over account ID.
368 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
369 },
370 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]371 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
372 # type.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]373 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
374 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
375 # rounded down to the start of the given date.
376 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
377 # rounded down to the start of the given date.
378 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
379 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]380 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
381 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
382 # rounded down to the start of the given date.
383 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
386 },
387 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
388 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
389 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
390 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]391 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
392 # Hangouts Chat.
393 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
394 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]395 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]396 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]397 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
398 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]399 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400</div>
401
402<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]403 <code class="details" id="list">list(matterId, view=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]409 view: string, Specifies which parts of the Hold to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]410 pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive.
411Leaving this empty, or as 0, is the same as page_size = 100.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]412 pageToken: string, The pagination token as returned in the response.
413An empty token means start from the beginning.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 x__xgafv: string, V1 error format.
415 Allowed values
416 1 - v1 error format
417 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418
419Returns:
420 An object of the form:
421
422 { # The holds for a matter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]423 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 # If this is empty, then there are no more holds to list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]425 &quot;holds&quot;: [ # The list of holds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 { # Represents a hold within Vault. A hold restricts purging of
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]430 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]431 &quot;orgUnit&quot;: { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
432 # accounts must be empty. This property is mutable. For groups holds,
433 # set the accounts field.
434 # This structure is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]435 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]436 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]438 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
439 # empty.
440 { # An account being held in a particular hold. This structure is immutable.
441 # This can be either a single user or a google group, depending on the corpus.
442 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
443 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
444 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
445 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
446 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
447 # precedence over account ID.
448 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
449 },
450 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]451 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
452 # type.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]453 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
454 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
455 # rounded down to the start of the given date.
456 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
457 # rounded down to the start of the given date.
458 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
459 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]460 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
461 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
462 # rounded down to the start of the given date.
463 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
466 },
467 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
468 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
469 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
470 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]471 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
472 # Hangouts Chat.
473 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
474 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]475 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]476 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]477 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
478 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]493 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]511 &quot;accountIds&quot;: [ # Account IDs to identify HeldAccounts to remove.
512 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]525 &quot;statuses&quot;: [ # A list of statuses for deleted accounts. Results have the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]534 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]535 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 # message types for APIs to use.
537 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]538 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]539 },
540 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]541 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
542 # user-facing error message should be localized and sent in the
543 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]565 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]566 &quot;orgUnit&quot;: { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
567 # accounts must be empty. This property is mutable. For groups holds,
568 # set the accounts field.
569 # This structure is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]570 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]571 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]572 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]573 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
574 # empty.
575 { # An account being held in a particular hold. This structure is immutable.
576 # This can be either a single user or a google group, depending on the corpus.
577 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
578 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
579 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
580 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
581 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
582 # precedence over account ID.
583 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
584 },
585 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]586 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]588 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
589 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
590 # rounded down to the start of the given date.
591 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
592 # rounded down to the start of the given date.
593 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
594 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]595 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
596 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
597 # rounded down to the start of the given date.
598 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
601 },
602 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
603 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
604 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
605 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]606 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]607 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]608 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]609 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]610 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]611 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]612 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
613 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]628 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]629 &quot;orgUnit&quot;: { # A organizational unit being held in a particular hold. # If set, the hold applies to all members of the organizational unit and
630 # accounts must be empty. This property is mutable. For groups holds,
631 # set the accounts field.
632 # This structure is immutable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]633 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]634 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]635 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]636 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
637 # empty.
638 { # An account being held in a particular hold. This structure is immutable.
639 # This can be either a single user or a google group, depending on the corpus.
640 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
641 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
642 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
643 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
644 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
645 # precedence over account ID.
646 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
647 },
648 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]649 &quot;query&quot;: { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
650 # type.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]651 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
652 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
653 # rounded down to the start of the given date.
654 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
655 # rounded down to the start of the given date.
656 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
657 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]658 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
659 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
660 # rounded down to the start of the given date.
661 &quot;endTime&quot;: &quot;A String&quot;, # 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 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
664 },
665 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
666 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
667 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
668 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]669 &quot;hangoutsChatQuery&quot;: { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
670 # Hangouts Chat.
671 &quot;includeRooms&quot;: True or False, # If true, include rooms the user has participated in.
672 },
673 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]674 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]675 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
676 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]677 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]678</div>
679
680</body></html>