Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/vault:v1.ts";

§Classes

GoogleAuth
Vault

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the required Vault privileges 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. For example, to download an export, an account needs the Manage Exports privilege and the matter shared with them.

§Variables

auth

§Interfaces

AccountCount

The results count for each account.

AccountCountError

An error that occurred when querying a specific account

AccountInfo

The accounts to search

AddHeldAccountResult

The status of each account creation, and the HeldAccount, if successful.

AddHeldAccountsRequest

Add a list of accounts to a hold.

AddHeldAccountsResponse

Response for batch create held accounts.

AddMatterPermissionsRequest

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.

CalendarExportOptions

The options for Calendar exports.

CalendarOptions

Additional options for Calendar search

CancelOperationRequest

The request message for Operations.CancelOperation.

CloseMatterRequest

Close a matter by ID.

CloseMatterResponse

Response to a CloseMatterRequest.

CloudStorageFile

The export file in Cloud Storage

CloudStorageSink

Export sink for Cloud Storage files.

CorpusQuery

Service-specific options for holds.

CountArtifactsMetadata

Long running operation metadata for CountArtifacts.

CountArtifactsRequest

Count artifacts request.

CountArtifactsResponse

Definition of the response for method CountArtifacts.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

DriveExportOptions

Options for Drive exports.

DriveOptions

Additional options for Drive search

Empty

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); }

Export

An export. To work with Vault resources, the account must have the required Vault privileges 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.

ExportOptions

Additional options for exports

ExportStats

Progress information for an export.

GroupsCountResult

Groups specific count metrics.

GroupsExportOptions

Options for Groups exports.

HangoutsChatExportOptions

Options for Chat exports.

HangoutsChatInfo

The Chat spaces to search

HangoutsChatOptions

Additional options for Google Chat search

HeldAccount

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.

HeldDriveQuery

Options for Drive holds.

HeldGroupsQuery

Query options for group holds.

HeldHangoutsChatQuery

Options for Chat holds.

HeldMailQuery

Query options for Gmail holds.

HeldOrgUnit

The organizational unit covered by a hold. This structure is immutable.

HeldVoiceQuery

Options for Voice holds.

Hold

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.

ListExportsResponse

The exports for a matter.

ListHeldAccountsResponse

Returns a list of the accounts covered by a hold.

ListHoldsResponse

The holds for a matter.

ListMattersResponse

Provides the list of matters.

ListOperationsResponse

The response message for Operations.ListOperations.

ListSavedQueriesResponse

Definition of the response for method ListSaveQuery.

MailCountResult

Gmail and classic Hangouts-specific count metrics.

MailExportOptions

Options for Gmail exports.

MailOptions

Additional options for Gmail search

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.

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.

MattersExportsListOptions

Additional options for Vault#mattersExportsList.

MattersGetOptions

Additional options for Vault#mattersGet.

MattersHoldsGetOptions

Additional options for Vault#mattersHoldsGet.

MattersHoldsListOptions

Additional options for Vault#mattersHoldsList.

MattersListOptions

Additional options for Vault#mattersList.

MattersSavedQueriesListOptions

Additional options for Vault#mattersSavedQueriesList.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationsListOptions

Additional options for Vault#operationsList.

OrgUnitInfo

The organizational unit to search

Query

The query definition used for search and export.

RemoveHeldAccountsRequest

Remove a list of accounts from a hold.

RemoveHeldAccountsResponse

Response for batch delete held accounts.

RemoveMatterPermissionsRequest

Remove an account as a matter collaborator.

ReopenMatterRequest

Reopen a matter by ID.

ReopenMatterResponse

Response to a ReopenMatterRequest.

SavedQuery

The definition of a saved query. To work with Vault resources, the account must have the required Vault privileges 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.

SharedDriveInfo

The shared drives to search

SitesUrlInfo

The published site URLs of new Google Sites to search

Status

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. 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.

TeamDriveInfo

Team Drives to search

UndeleteMatterRequest

Undelete a matter by ID.

UserInfo

User's information.

VoiceExportOptions

The options for Voice exports.

VoiceOptions

Additional options for Voice search