Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / vault_v1.matters.holds.html
blob: 23eec1815e8cdfe13b30f239601cbece4a10f912 [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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 <code><a href="#list">list(matterId, pageToken=None, pageSize=None, view=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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &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]150 # message types for APIs to use.
151 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &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]153 },
154 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
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 Kim65020912020-05-20 12:08:20 -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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
163 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
164 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
167 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
168 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 # empty.
190 { # An account being held in a particular hold. This structure is immutable.
191 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
193 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
194 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]196 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
197 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
198 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 },
200 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &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]202 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
204 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
205 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
206 # rounded down to the start of the given date.
207 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
208 # rounded down to the start of the given date.
209 },
210 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
211 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
212 # rounded down to the start of the given date.
213 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
214 # rounded down to the start of the given date.
215 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
216 },
217 &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]218 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]219 &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]220 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
222 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
223 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 },
225 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &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
227 # accounts must be empty. This property is mutable. For groups holds,
228 # set the accounts field.
229 # This structure is immutable.
230 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
231 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
232 },
233 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
234 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
235 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
236 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 # empty.
253 { # An account being held in a particular hold. This structure is immutable.
254 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
256 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
257 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]259 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
260 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
261 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 },
263 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]264 &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]265 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]266 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
267 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
268 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
269 # rounded down to the start of the given date.
270 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
271 # rounded down to the start of the given date.
272 },
273 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
274 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
275 # rounded down to the start of the given date.
276 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
277 # rounded down to the start of the given date.
278 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
279 },
280 &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]281 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]282 &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]283 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]284 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
285 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
286 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 },
288 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &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
290 # accounts must be empty. This property is mutable. For groups holds,
291 # set the accounts field.
292 # This structure is immutable.
293 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
294 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
295 },
296 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
297 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
298 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
299 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
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
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]350 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 # empty.
352 { # An account being held in a particular hold. This structure is immutable.
353 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]354 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
355 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
356 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]358 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
359 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
360 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]361 },
362 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]363 &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]364 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]365 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
366 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
367 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
368 # rounded down to the start of the given date.
369 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
370 # rounded down to the start of the given date.
371 },
372 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
373 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
374 # rounded down to the start of the given date.
375 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
376 # rounded down to the start of the given date.
377 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
378 },
379 &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]380 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]381 &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]382 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]383 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
384 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
385 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 },
387 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 &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
389 # accounts must be empty. This property is mutable. For groups holds,
390 # set the accounts field.
391 # This structure is immutable.
392 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
393 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
394 },
395 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
396 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
397 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
398 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 }</pre>
400</div>
401
402<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]403 <code class="details" id="list">list(matterId, pageToken=None, pageSize=None, view=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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 pageToken: string, The pagination token as returned in the response.
410An empty token means start from the beginning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]411 pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive.
412Leaving this empty, or as 0, is the same as page_size = 100.
413 view: string, Specifies which parts of the Hold to return.
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
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 # empty.
432 { # An account being held in a particular hold. This structure is immutable.
433 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]434 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
435 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
436 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]438 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
439 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
440 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 },
442 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 &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]444 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]445 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
446 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
447 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
448 # rounded down to the start of the given date.
449 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
450 # rounded down to the start of the given date.
451 },
452 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
453 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
454 # rounded down to the start of the given date.
455 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
456 # rounded down to the start of the given date.
457 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
458 },
459 &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]460 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]461 &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]462 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]463 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
464 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
465 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 },
467 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]468 &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
469 # accounts must be empty. This property is mutable. For groups holds,
470 # set the accounts field.
471 # This structure is immutable.
472 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
473 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
474 },
475 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
476 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
477 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
478 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]534 &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]535 # message types for APIs to use.
536 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]537 &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]538 },
539 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]540 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
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
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]565 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566 # empty.
567 { # An account being held in a particular hold. This structure is immutable.
568 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]569 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
570 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
571 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]572 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]573 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
574 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
575 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576 },
577 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]578 &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]579 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]580 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
581 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
582 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
583 # rounded down to the start of the given date.
584 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
585 # rounded down to the start of the given date.
586 },
587 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
588 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
589 # rounded down to the start of the given date.
590 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
591 # rounded down to the start of the given date.
592 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
593 },
594 &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]595 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]596 &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]597 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]598 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
599 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
600 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 },
602 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]603 &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
604 # accounts must be empty. This property is mutable. For groups holds,
605 # set the accounts field.
606 # This structure is immutable.
607 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
608 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
609 },
610 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
611 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
612 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
613 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]628 &quot;accounts&quot;: [ # If set, the hold applies to the enumerated accounts and org_unit must be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]629 # empty.
630 { # An account being held in a particular hold. This structure is immutable.
631 # This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]632 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
633 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
634 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]635 # precedence over account ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]636 &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
637 # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
638 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]639 },
640 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]641 &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]642 # type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]643 &quot;mailQuery&quot;: { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
644 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
645 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
646 # rounded down to the start of the given date.
647 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
648 # rounded down to the start of the given date.
649 },
650 &quot;groupsQuery&quot;: { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
651 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
652 # rounded down to the start of the given date.
653 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
654 # rounded down to the start of the given date.
655 &quot;terms&quot;: &quot;A String&quot;, # The search terms for the hold.
656 },
657 &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]658 # Hangouts Chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]659 &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]660 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]661 &quot;driveQuery&quot;: { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
662 &quot;includeTeamDriveFiles&quot;: True or False, # If true, include files in Team Drives in the hold.
663 &quot;includeSharedDriveFiles&quot;: True or False, # If true, include files in shared drives in the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]664 },
665 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]666 &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
667 # accounts must be empty. This property is mutable. For groups holds,
668 # set the accounts field.
669 # This structure is immutable.
670 &quot;holdTime&quot;: &quot;A String&quot;, # When the org unit was put on hold. This property is immutable.
671 &quot;orgUnitId&quot;: &quot;A String&quot;, # The org unit&#x27;s immutable ID as provided by the Admin SDK.
672 },
673 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to be searched.
674 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
675 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
676 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]677 }</pre>
678</div>
679
680</body></html>