1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="vault_v1.matters.exports.html">exports()</a></code>
</p>
<p class="firstline">Returns the exports Resource.</p>
<p class="toc_element">
<code><a href="vault_v1.matters.holds.html">holds()</a></code>
</p>
<p class="firstline">Returns the holds Resource.</p>
<p class="toc_element">
<code><a href="vault_v1.matters.savedQueries.html">savedQueries()</a></code>
</p>
<p class="firstline">Returns the savedQueries Resource.</p>
<p class="toc_element">
<code><a href="#addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds an account as a matter collaborator.</p>
<p class="toc_element">
<code><a href="#close">close(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Closes the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#count">count(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Counts the accounts processed by the specified query.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.</p>
<p class="toc_element">
<code><a href="#delete">delete(matterId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#get">get(matterId, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified matter.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matters the requestor has access to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes an account as a matter collaborator.</p>
<p class="toc_element">
<code><a href="#reopen">reopen(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reopens the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Undeletes the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#update">update(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addPermissions">addPermissions(matterId, body=None, x__xgafv=None)</code>
<pre>Adds an account as a matter collaborator.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.
"ccMe": True or False, # Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.
"matterPermission": { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. # The account and its role to add.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
"sendEmails": True or False, # To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close(matterId, body=None, x__xgafv=None)</code>
<pre>Closes the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Close a matter by ID.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to a CloseMatterRequest.
"matter": { # Represents a matter. 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. # The updated matter, with state **CLOSED**.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
},
}</pre>
</div>
<div class="method">
<code class="details" id="count">count(matterId, body=None, x__xgafv=None)</code>
<pre>Counts the accounts processed by the specified query.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Count artifacts request.
"query": { # The query definition used for search and export. # The search query.
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
"emails": [ # A set of accounts to search.
"A String",
],
},
"calendarOptions": { # Additional options for Calendar search # Set Calendar search-specific options.
"locationQuery": [ # Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in "and". Word splitting example: ["New Zealand"] vs ["New","Zealand"] "New Zealand": matched by both "New and better Zealand": only matched by the later
"A String",
],
"minusWords": [ # Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in "or".
"A String",
],
"peopleQuery": [ # Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in "and".
"A String",
],
"responseStatuses": [ # Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.
"A String",
],
"versionDate": "A String", # Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
"corpus": "A String", # The Google Workspace service to search.
"dataScope": "A String", # The data source to search.
"driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**.
"documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID.
"ids": [ # Required. A list of Drive document IDs.
"A String",
],
},
},
"driveOptions": { # Additional options for Drive search. # Set Drive search-specific options.
"clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
"includeTeamDrives": True or False, # Set to true to include Team Drive.
"sharedDrivesOption": "A String", # Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
"versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options.
},
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.
"A String",
],
},
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
"clientSideEncryptedOption": "A String", # Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
},
"method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
"orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
"searchMethod": "A String", # The search method to use.
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"sitesUrlInfo": { # The published site URLs of new Google Sites to search # Required when **SearchMethod** is **SITES_URL**.
"urls": [ # A list of published site URLs.
"A String",
],
},
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
"coveredData": [ # Datatypes to search
"A String",
],
},
},
"view": "A String", # Sets the granularity of the count results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
Args:
body: object, The request body.
The object takes the form of:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(matterId, x__xgafv=None)</code>
<pre>Deletes the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(matterId, view=None, x__xgafv=None)</code>
<pre>Gets the specified matter.
Args:
matterId: string, The matter ID. (required)
view: string, Specifies how much information about the matter to return in the response.
Allowed values
VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**.
BASIC - Returns the matter ID, name, description, and state. Default choice.
FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission)).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)</code>
<pre>Lists matters the requestor has access to.
Args:
pageSize: integer, The number of matters to return in the response. Default and maximum are 100.
pageToken: string, The pagination token as returned in the response.
state: string, If set, lists only matters with the specified state. The default lists matters of all states.
Allowed values
STATE_UNSPECIFIED - The matter has no specified state.
OPEN - The matter is open.
CLOSED - The matter is closed.
DELETED - The matter is deleted.
view: string, Specifies how much information about the matter to return in response.
Allowed values
VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**.
BASIC - Returns the matter ID, name, description, and state. Default choice.
FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission)).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Provides the list of matters.
"matters": [ # List of matters.
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
},
],
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="removePermissions">removePermissions(matterId, body=None, x__xgafv=None)</code>
<pre>Removes an account as a matter collaborator.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Remove an account as a matter collaborator.
"accountId": "A String", # The account ID.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="reopen">reopen(matterId, body=None, x__xgafv=None)</code>
<pre>Reopens the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Reopen a matter by ID.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to a ReopenMatterRequest.
"matter": { # Represents a matter. 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. # The updated matter, with state **OPEN**.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
},
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(matterId, body=None, x__xgafv=None)</code>
<pre>Undeletes the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Undelete a matter by ID.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(matterId, body=None, x__xgafv=None)</code>
<pre>Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a matter. 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.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}</pre>
</div>
</body></html>
|
