blob: 804c3ffe6e4e396108960fce2223251240ca9524 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
yoshi-code-bot8bb904c2021-08-31 00:28:27 -070075<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.holds.html">holds</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="vault_v1.matters.holds.accounts.html">accounts()</a></code>
79</p>
80<p class="firstline">Returns the accounts Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070083 <code><a href="#addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -070084<p class="firstline">Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="toc_element">
86 <code><a href="#close">close()</a></code></p>
87<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070089 <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -070090<p class="firstline">Creates a hold in the specified matter.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="toc_element">
92 <code><a href="#delete">delete(matterId, holdId, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -070093<p class="firstline">Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070095 <code><a href="#get">get(matterId, holdId, view=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -070096<p class="firstline">Gets the specified hold.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080098 <code><a href="#list">list(matterId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -070099<p class="firstline">Lists the holds in a matter.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="toc_element">
101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
102<p class="firstline">Retrieves the next page of results.</p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 <code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700105<p class="firstline">Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code><a href="#update">update(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700108<p class="firstline">Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<h3>Method Details</h3>
110<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700112 <pre>Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113
114Args:
115 matterId: string, The matter ID. (required)
116 holdId: string, The hold ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700117 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118 The object takes the form of:
119
120{ # Add a list of accounts to a hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700121 &quot;accountIds&quot;: [ # A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 &quot;A String&quot;,
123 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700124 &quot;emails&quot;: [ # A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &quot;A String&quot;,
126 ],
127}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134Returns:
135 An object of the form:
136
137 { # Response for batch create held accounts.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;responses&quot;: [ # The list of responses, in the same order as the batch request.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700139 { # The status of each account creation, and the **HeldAccount**, if successful.
140 &quot;account&quot;: { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # Returned when the account was successfully created.
141 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
142 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800143 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
144 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
145 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700146 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700147 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Reports the request status. If it failed, returns an error message.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800148 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
149 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
150 {
151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
153 ],
154 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
155 },
156 },
157 ],
158}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700159</div>
160
161<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700162 <code class="details" id="close">close()</code>
163 <pre>Close httplib2 connections.</pre>
164</div>
165
166<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700167 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700168 <pre>Creates a hold in the specified matter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700169
170Args:
171 matterId: string, The matter ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700172 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700173 The object takes the form of:
174
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700175{ # A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
176 &quot;accounts&quot;: [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
177 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
178 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
179 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800180 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
181 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
182 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
183 },
184 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700185 &quot;corpus&quot;: &quot;A String&quot;, # The service to be searched.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800186 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
187 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700188 &quot;orgUnit&quot;: { # The organizational unit covered by a hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
189 &quot;holdTime&quot;: &quot;A String&quot;, # When the organizational unit was put on hold. This property is immutable.
190 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit&#x27;s immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800191 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700192 &quot;query&quot;: { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
193 &quot;driveQuery&quot;: { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
194 &quot;includeSharedDriveFiles&quot;: True or False, # To include files in shared drives in the hold, set to **true**.
195 &quot;includeTeamDriveFiles&quot;: True or False, # To include files in Team Drives in the hold, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800196 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700197 &quot;groupsQuery&quot;: { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
198 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
199 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
200 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800201 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700202 &quot;hangoutsChatQuery&quot;: { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
203 &quot;includeRooms&quot;: True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700205 &quot;mailQuery&quot;: { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
206 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
207 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
208 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800209 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700210 &quot;voiceQuery&quot;: { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
211 &quot;coveredData&quot;: [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800212 &quot;A String&quot;,
213 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800214 },
215 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800216 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800217}
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700218
219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224Returns:
225 An object of the form:
226
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700227 { # A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
228 &quot;accounts&quot;: [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
229 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
230 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
231 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800232 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
233 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
234 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800235 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800236 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700237 &quot;corpus&quot;: &quot;A String&quot;, # The service to be searched.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800238 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
239 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700240 &quot;orgUnit&quot;: { # The organizational unit covered by a hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
241 &quot;holdTime&quot;: &quot;A String&quot;, # When the organizational unit was put on hold. This property is immutable.
242 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit&#x27;s immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800243 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700244 &quot;query&quot;: { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
245 &quot;driveQuery&quot;: { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
246 &quot;includeSharedDriveFiles&quot;: True or False, # To include files in shared drives in the hold, set to **true**.
247 &quot;includeTeamDriveFiles&quot;: True or False, # To include files in Team Drives in the hold, set to **true**.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800248 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700249 &quot;groupsQuery&quot;: { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
250 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
251 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
252 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800253 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700254 &quot;hangoutsChatQuery&quot;: { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
255 &quot;includeRooms&quot;: True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800256 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700257 &quot;mailQuery&quot;: { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
258 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
259 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
260 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800261 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700262 &quot;voiceQuery&quot;: { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
263 &quot;coveredData&quot;: [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800264 &quot;A String&quot;,
265 ],
266 },
267 },
268 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
269}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270</div>
271
272<div class="method">
273 <code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700274 <pre>Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700275
276Args:
277 matterId: string, The matter ID. (required)
278 holdId: string, The hold ID. (required)
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
285 An object of the form:
286
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700287 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800288}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700289</div>
290
291<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700292 <code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700293 <pre>Gets the specified hold.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700294
295Args:
296 matterId: string, The matter ID. (required)
297 holdId: string, The hold ID. (required)
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700298 view: string, The amount of detail to return for a hold.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700299 Allowed values
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700300 HOLD_VIEW_UNSPECIFIED - Not specified. Defaults to **FULL_HOLD**.
301 BASIC_HOLD - Returns the hold ID, name, update time, service, and query.
302 FULL_HOLD - Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700303 x__xgafv: string, V1 error format.
304 Allowed values
305 1 - v1 error format
306 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700307
308Returns:
309 An object of the form:
310
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700311 { # A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
312 &quot;accounts&quot;: [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
313 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
314 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
315 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800316 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
317 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
318 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800319 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800320 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700321 &quot;corpus&quot;: &quot;A String&quot;, # The service to be searched.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800322 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
323 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700324 &quot;orgUnit&quot;: { # The organizational unit covered by a hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
325 &quot;holdTime&quot;: &quot;A String&quot;, # When the organizational unit was put on hold. This property is immutable.
326 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit&#x27;s immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800327 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700328 &quot;query&quot;: { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
329 &quot;driveQuery&quot;: { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
330 &quot;includeSharedDriveFiles&quot;: True or False, # To include files in shared drives in the hold, set to **true**.
331 &quot;includeTeamDriveFiles&quot;: True or False, # To include files in Team Drives in the hold, set to **true**.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800332 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700333 &quot;groupsQuery&quot;: { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
334 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
335 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
336 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800337 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700338 &quot;hangoutsChatQuery&quot;: { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
339 &quot;includeRooms&quot;: True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800340 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700341 &quot;mailQuery&quot;: { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
342 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
343 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
344 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800345 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700346 &quot;voiceQuery&quot;: { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
347 &quot;coveredData&quot;: [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800348 &quot;A String&quot;,
349 ],
350 },
351 },
352 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
353}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700354</div>
355
356<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800357 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700358 <pre>Lists the holds in a matter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700359
360Args:
361 matterId: string, The matter ID. (required)
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700362 pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800363 pageToken: string, The pagination token as returned in the response. An empty token means start from the beginning.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700364 view: string, The amount of detail to return for a hold.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700365 Allowed values
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700366 HOLD_VIEW_UNSPECIFIED - Not specified. Defaults to **FULL_HOLD**.
367 BASIC_HOLD - Returns the hold ID, name, update time, service, and query.
368 FULL_HOLD - Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700369 x__xgafv: string, V1 error format.
370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700373
374Returns:
375 An object of the form:
376
377 { # The holds for a matter.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800378 &quot;holds&quot;: [ # The list of holds.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700379 { # A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
380 &quot;accounts&quot;: [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
381 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
382 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
383 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800384 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
385 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
386 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700387 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800388 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700389 &quot;corpus&quot;: &quot;A String&quot;, # The service to be searched.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800390 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
391 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700392 &quot;orgUnit&quot;: { # The organizational unit covered by a hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
393 &quot;holdTime&quot;: &quot;A String&quot;, # When the organizational unit was put on hold. This property is immutable.
394 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit&#x27;s immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800395 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700396 &quot;query&quot;: { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
397 &quot;driveQuery&quot;: { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
398 &quot;includeSharedDriveFiles&quot;: True or False, # To include files in shared drives in the hold, set to **true**.
399 &quot;includeTeamDriveFiles&quot;: True or False, # To include files in Team Drives in the hold, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800400 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700401 &quot;groupsQuery&quot;: { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
402 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
403 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
404 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800405 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700406 &quot;hangoutsChatQuery&quot;: { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
407 &quot;includeRooms&quot;: True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800408 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700409 &quot;mailQuery&quot;: { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
410 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
411 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
412 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800413 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700414 &quot;voiceQuery&quot;: { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
415 &quot;coveredData&quot;: [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800416 &quot;A String&quot;,
417 ],
418 },
419 },
420 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
421 },
422 ],
423 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
424}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700425</div>
426
427<div class="method">
428 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
429 <pre>Retrieves the next page of results.
430
431Args:
432 previous_request: The request for the previous page. (required)
433 previous_response: The response from the request for the previous page. (required)
434
435Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700436 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700437 page. Returns None if there are no more items in the collection.
438 </pre>
439</div>
440
441<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700442 <code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700443 <pre>Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700444
445Args:
446 matterId: string, The matter ID. (required)
447 holdId: string, The hold ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700448 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700449 The object takes the form of:
450
451{ # Remove a list of accounts from a hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700452 &quot;accountIds&quot;: [ # The account IDs of the accounts to remove from the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800453 &quot;A String&quot;,
454 ],
455}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700456
457 x__xgafv: string, V1 error format.
458 Allowed values
459 1 - v1 error format
460 2 - v2 error format
461
462Returns:
463 An object of the form:
464
465 { # Response for batch delete held accounts.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700466 &quot;statuses&quot;: [ # A list of statuses for the deleted accounts. Results have the same order as the request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800467 { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
468 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
469 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
470 {
471 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
472 },
473 ],
474 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
475 },
476 ],
477}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700478</div>
479
480<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700481 <code class="details" id="update">update(matterId, holdId, body=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700482 <pre>Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700483
484Args:
485 matterId: string, The matter ID. (required)
486 holdId: string, The ID of the hold. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700487 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700488 The object takes the form of:
489
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700490{ # A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
491 &quot;accounts&quot;: [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
492 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
493 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
494 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800495 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
496 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
497 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
498 },
499 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700500 &quot;corpus&quot;: &quot;A String&quot;, # The service to be searched.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800501 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
502 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700503 &quot;orgUnit&quot;: { # The organizational unit covered by a hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
504 &quot;holdTime&quot;: &quot;A String&quot;, # When the organizational unit was put on hold. This property is immutable.
505 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit&#x27;s immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800506 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700507 &quot;query&quot;: { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
508 &quot;driveQuery&quot;: { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
509 &quot;includeSharedDriveFiles&quot;: True or False, # To include files in shared drives in the hold, set to **true**.
510 &quot;includeTeamDriveFiles&quot;: True or False, # To include files in Team Drives in the hold, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800511 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700512 &quot;groupsQuery&quot;: { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
513 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
514 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
515 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800516 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700517 &quot;hangoutsChatQuery&quot;: { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
518 &quot;includeRooms&quot;: True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
Bu Sun Kim65020912020-05-20 12:08:20 -0700519 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700520 &quot;mailQuery&quot;: { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
521 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
522 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
523 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800524 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700525 &quot;voiceQuery&quot;: { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
526 &quot;coveredData&quot;: [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800527 &quot;A String&quot;,
528 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800529 },
530 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800531 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800532}
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700533
534 x__xgafv: string, V1 error format.
535 Allowed values
536 1 - v1 error format
537 2 - v2 error format
538
539Returns:
540 An object of the form:
541
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700542 { # A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
543 &quot;accounts&quot;: [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
544 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
545 &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
546 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800547 &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
548 &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
549 &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800550 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800551 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700552 &quot;corpus&quot;: &quot;A String&quot;, # The service to be searched.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800553 &quot;holdId&quot;: &quot;A String&quot;, # The unique immutable ID of the hold. Assigned during creation.
554 &quot;name&quot;: &quot;A String&quot;, # The name of the hold.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700555 &quot;orgUnit&quot;: { # The organizational unit covered by a hold. This structure is immutable. # If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
556 &quot;holdTime&quot;: &quot;A String&quot;, # When the organizational unit was put on hold. This property is immutable.
557 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit&#x27;s immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800558 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700559 &quot;query&quot;: { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
560 &quot;driveQuery&quot;: { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
561 &quot;includeSharedDriveFiles&quot;: True or False, # To include files in shared drives in the hold, set to **true**.
562 &quot;includeTeamDriveFiles&quot;: True or False, # To include files in Team Drives in the hold, set to **true**.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800563 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700564 &quot;groupsQuery&quot;: { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
565 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
566 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
567 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800568 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700569 &quot;hangoutsChatQuery&quot;: { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
570 &quot;includeRooms&quot;: True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800571 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700572 &quot;mailQuery&quot;: { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
573 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
574 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
575 &quot;terms&quot;: &quot;A String&quot;, # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800576 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700577 &quot;voiceQuery&quot;: { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
578 &quot;coveredData&quot;: [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800579 &quot;A String&quot;,
580 ],
581 },
582 },
583 &quot;updateTime&quot;: &quot;A String&quot;, # The last time this hold was modified.
584}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700585</div>
586
587</body></html>