01README
Google Cloud vault infrastructure models
02Models
@swamp/gcp/vault/mattersv2026.04.23.1matters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | An optional description for the matter. |
| matterId? | string | The matter ID, which is generated by the server. Leave blank when creating a matter. |
| matterPermissions? | array | 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. |
| matterRegion? | enum | Optional. The requested data region for the matter. |
| name? | string | The name of the matter. |
| state? | enum | The state of the matter. |
fn create()
Create a matters
fn get(identifier: string)
Get a matters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the matters |
fn update()
Update matters attributes
fn delete(identifier: string)
Delete the matters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the matters |
fn sync()
Sync matters state from GCP
fn add_permissions(ccMe?: any, matterPermission?: any, sendEmails?: any)
add permissions
| Argument | Type | Description |
|---|---|---|
| ccMe? | any | |
| matterPermission? | any | |
| sendEmails? | any |
fn close()
close
fn count(query?: any, view?: any)
count
| Argument | Type | Description |
|---|---|---|
| query? | any | |
| view? | any |
fn reopen()
reopen
fn undelete()
undelete
Resources
state(infinite)— Represents a matter. To work with Vault resources, the account must have the ...
@swamp/gcp/vault/matters-exportsv2026.04.23.1matters_exports.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| cloudStorageSink? | object | Export sink for Cloud Storage files. |
| exportOptions? | object | Additional options for exports |
| matterId? | string | Output only. The matter ID. |
| name? | string | The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports. |
| query? | object | The query definition used for search and export. |
| requester? | object | User's information. |
| stats? | object | Progress information for an export. |
fn create(waitForReady?: boolean)
Create a exports
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a exports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the exports |
fn delete(identifier: string)
Delete the exports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the exports |
fn sync()
Sync exports state from GCP
Resources
state(infinite)— An export. To work with Vault resources, the account must have the [required ...
@swamp/gcp/vault/matters-holdsv2026.04.23.1matters_holds.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accounts? | array | If set, the hold applies to the specified accounts and **orgUnit** must be empty. |
| corpus? | enum | The service to be searched. |
| holdId? | string | The unique immutable ID of the hold. Assigned during creation. |
| name? | string | The name of the hold. |
| orgUnit? | object | The organizational unit covered by a hold. This structure is immutable. |
| query? | object | Service-specific options for holds. |
| updateTime? | string | The last time this hold was modified. |
| matterId | string | The matter ID. |
fn create()
Create a holds
fn get(identifier: string)
Get a holds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the holds |
fn update()
Update holds attributes
fn delete(identifier: string)
Delete the holds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the holds |
fn sync()
Sync holds state from GCP
fn add_held_accounts(accountIds?: any, emails?: any)
add held accounts
| Argument | Type | Description |
|---|---|---|
| accountIds? | any | |
| emails? | any |
Resources
state(infinite)— A hold. A hold prevents the specified Google Workspace service from purging d...
@swamp/gcp/vault/matters-holds-accountsv2026.04.23.1matters_holds_accounts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accountId? | string | The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). |
| email? | string | The primary email address of the account. If used as an input, this takes precedence over **accountId**. |
| matterId | string | The matter ID. |
| holdId | string | The hold ID. |
fn create()
Create a accounts
fn get(identifier: string)
Get a accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn delete(identifier: string)
Delete the accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn sync()
Sync accounts state from GCP
Resources
state(infinite)— An account covered by a hold. This structure is immutable. It can be an indiv...
@swamp/gcp/vault/matters-savedqueriesv2026.04.23.1matters_savedqueries.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | The name of the saved query. |
| matterId? | string | Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. |
| query? | object | The query definition used for search and export. |
| savedQueryId? | string | A unique identifier for the saved query. |
fn create()
Create a savedQueries
fn get(identifier: string)
Get a savedQueries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the savedQueries |
fn delete(identifier: string)
Delete the savedQueries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the savedQueries |
fn sync()
Sync savedQueries state from GCP
Resources
state(infinite)— The definition of a saved query. To work with Vault resources, the account mu...
03Previous Versions
2026.04.03.3Apr 3, 2026
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.04.03.1Apr 3, 2026
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
04Stats
A
100 / 100
Downloads
0
Archive size
43.2 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels