Class v1.SecretManagerServiceClient (3.8.1)

Version 3.8.1

• 5.4.0 (latest)
• 5.2.0
• 4.2.2
• 4.1.4
• 3.12.0
• 3.11.0
• 3.10.1
• 3.9.1
• 3.8.1
• 3.7.3

Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

* * v1

Package

@google-cloud/secret-manager!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of SecretManagerServiceClient.

Parameter

Name	Description
opts	ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

secretManagerServiceStub

secretManagerServiceStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

accessSecretVersion(request, options)

accessSecretVersion(request?: protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.IAccessSecretVersionResponse, (protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.IAccessSecretVersionResponse, (protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest | undefined), {} | undefined]>

accessSecretVersion(request, options, callback)

accessSecretVersion(request: protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.IAccessSecretVersionResponse, protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.IAccessSecretVersionResponse, protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

accessSecretVersion(request, callback)

accessSecretVersion(request: protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest, callback: Callback<protos.google.cloud.secretmanager.v1.IAccessSecretVersionResponse, protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest
callback	Callback<protos.google.cloud.secretmanager.v1.IAccessSecretVersionResponse, protos.google.cloud.secretmanager.v1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

addSecretVersion(request, options)

addSecretVersion(request?: protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest | undefined, {} | undefined]>

addSecretVersion(request, options, callback)

addSecretVersion(request: protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

addSecretVersion(request, callback)

addSecretVersion(request: protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createSecret(request, options)

createSecret(request?: protos.google.cloud.secretmanager.v1.ICreateSecretRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.ICreateSecretRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.ICreateSecretRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.ICreateSecretRequest | undefined, {} | undefined]>

createSecret(request, options, callback)

createSecret(request: protos.google.cloud.secretmanager.v1.ICreateSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.ICreateSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.ICreateSecretRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.ICreateSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

createSecret(request, callback)

createSecret(request: protos.google.cloud.secretmanager.v1.ICreateSecretRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.ICreateSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.ICreateSecretRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.ICreateSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteSecret(request, options)

deleteSecret(request?: protos.google.cloud.secretmanager.v1.IDeleteSecretRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.secretmanager.v1.IDeleteSecretRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDeleteSecretRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.secretmanager.v1.IDeleteSecretRequest | undefined, {} | undefined]>

deleteSecret(request, options, callback)

deleteSecret(request: protos.google.cloud.secretmanager.v1.IDeleteSecretRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secretmanager.v1.IDeleteSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDeleteSecretRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secretmanager.v1.IDeleteSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteSecret(request, callback)

deleteSecret(request: protos.google.cloud.secretmanager.v1.IDeleteSecretRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secretmanager.v1.IDeleteSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDeleteSecretRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secretmanager.v1.IDeleteSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

destroySecretVersion(request, options)

destroySecretVersion(request?: protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, (protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, (protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest | undefined), {} | undefined]>

destroySecretVersion(request, options, callback)

destroySecretVersion(request: protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

destroySecretVersion(request, callback)

destroySecretVersion(request: protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

disableSecretVersion(request, options)

disableSecretVersion(request?: protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, (protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, (protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest | undefined), {} | undefined]>

disableSecretVersion(request, options, callback)

disableSecretVersion(request: protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

disableSecretVersion(request, callback)

disableSecretVersion(request: protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

enableSecretVersion(request, options)

enableSecretVersion(request?: protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, (protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest | undefined), {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, (protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest | undefined), {} | undefined]>

enableSecretVersion(request, options, callback)

enableSecretVersion(request: protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

enableSecretVersion(request, callback)

enableSecretVersion(request: protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.iam.v1.IGetIamPolicyRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.IGetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.IGetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	Callback<string, undefined, undefined>

Returns

Type	Description
void

getSecret(request, options)

getSecret(request?: protos.google.cloud.secretmanager.v1.IGetSecretRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IGetSecretRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IGetSecretRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IGetSecretRequest | undefined, {} | undefined]>

getSecret(request, options, callback)

getSecret(request: protos.google.cloud.secretmanager.v1.IGetSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IGetSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IGetSecretRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IGetSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getSecret(request, callback)

getSecret(request: protos.google.cloud.secretmanager.v1.IGetSecretRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IGetSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IGetSecretRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IGetSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getSecretVersion(request, options)

getSecretVersion(request?: protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest | undefined, {} | undefined]>

getSecretVersion(request, options, callback)

getSecretVersion(request: protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getSecretVersion(request, callback)

getSecretVersion(request: protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecretVersion, protos.google.cloud.secretmanager.v1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listSecrets(request, options)

listSecrets(request?: protos.google.cloud.secretmanager.v1.IListSecretsRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecret[], protos.google.cloud.secretmanager.v1.IListSecretsRequest | null, protos.google.cloud.secretmanager.v1.IListSecretsResponse]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretsRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecret[], protos.google.cloud.secretmanager.v1.IListSecretsRequest | null, protos.google.cloud.secretmanager.v1.IListSecretsResponse]>

listSecrets(request, options, callback)

listSecrets(request: protos.google.cloud.secretmanager.v1.IListSecretsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretsRequest, protos.google.cloud.secretmanager.v1.IListSecretsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecret>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretsRequest, protos.google.cloud.secretmanager.v1.IListSecretsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecret>

Returns

Type	Description
void

listSecrets(request, callback)

listSecrets(request: protos.google.cloud.secretmanager.v1.IListSecretsRequest, callback: PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretsRequest, protos.google.cloud.secretmanager.v1.IListSecretsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecret>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretsRequest
callback	PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretsRequest, protos.google.cloud.secretmanager.v1.IListSecretsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecret>

Returns

Type	Description
void

listSecretsAsync(request, options)

listSecretsAsync(request?: protos.google.cloud.secretmanager.v1.IListSecretsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.secretmanager.v1.ISecret>;

Equivalent to listSecrets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.secretmanager.v1.ISecret>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Secret]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSecretsStream(request, options)

listSecretsStream(request?: protos.google.cloud.secretmanager.v1.IListSecretsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [Secret] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSecretsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSecretVersions(request, options)

listSecretVersions(request?: protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion[], protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest | null, protos.google.cloud.secretmanager.v1.IListSecretVersionsResponse]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecretVersion[], protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest | null, protos.google.cloud.secretmanager.v1.IListSecretVersionsResponse]>

listSecretVersions(request, options, callback)

listSecretVersions(request: protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, protos.google.cloud.secretmanager.v1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecretVersion>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, protos.google.cloud.secretmanager.v1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecretVersion>

Returns

Type	Description
void

listSecretVersions(request, callback)

listSecretVersions(request: protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, callback: PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, protos.google.cloud.secretmanager.v1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecretVersion>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest
callback	PaginationCallback<protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, protos.google.cloud.secretmanager.v1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secretmanager.v1.ISecretVersion>

Returns

Type	Description
void

listSecretVersionsAsync(request, options)

listSecretVersionsAsync(request?: protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.secretmanager.v1.ISecretVersion>;

Equivalent to listSecretVersions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.secretmanager.v1.ISecretVersion>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [SecretVersion]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSecretVersionsStream(request, options)

listSecretVersionsStream(request?: protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IListSecretVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns

Type

Description

Transform

{Stream} An object stream which emits an object representing [SecretVersion] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSecretVersionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	string A fully-qualified path representing Project resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromSecretName(secretName)

matchProjectFromSecretName(secretName: string): string | number;

Parse the project from Secret resource.

Parameter

Name	Description
secretName	string A fully-qualified path representing Secret resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromSecretVersionName(secretVersionName)

matchProjectFromSecretVersionName(secretVersionName: string): string | number;

Parse the project from SecretVersion resource.

Parameter

Name	Description
secretVersionName	string A fully-qualified path representing SecretVersion resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromTopicName(topicName)

matchProjectFromTopicName(topicName: string): string | number;

Parse the project from Topic resource.

Parameter

Name	Description
topicName	string A fully-qualified path representing Topic resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchSecretFromSecretName(secretName)

matchSecretFromSecretName(secretName: string): string | number;

Parse the secret from Secret resource.

Parameter

Name	Description
secretName	string A fully-qualified path representing Secret resource.

Returns

Type	Description
string | number	{string} A string representing the secret.

matchSecretFromSecretVersionName(secretVersionName)

matchSecretFromSecretVersionName(secretVersionName: string): string | number;

Parse the secret from SecretVersion resource.

Parameter

Name	Description
secretVersionName	string A fully-qualified path representing SecretVersion resource.

Returns

Type	Description
string | number	{string} A string representing the secret.

matchSecretVersionFromSecretVersionName(secretVersionName)

matchSecretVersionFromSecretVersionName(secretVersionName: string): string | number;

Parse the secret_version from SecretVersion resource.

Parameter

Name	Description
secretVersionName	string A fully-qualified path representing SecretVersion resource.

Returns

Type	Description
string | number	{string} A string representing the secret_version.

matchTopicFromTopicName(topicName)

matchTopicFromTopicName(topicName: string): string | number;

Parse the topic from Topic resource.

Parameter

Name	Description
topicName	string A fully-qualified path representing Topic resource.

Returns

Type	Description
string | number	{string} A string representing the topic.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	string

Returns

Type	Description
string	{string} Resource name string.

secretPath(project, secret)

secretPath(project: string, secret: string): string;

Return a fully-qualified secret resource name string.

Parameters

Name	Description
project	string
secret	string

Returns

Type	Description
string	{string} Resource name string.

secretVersionPath(project, secret, secretVersion)

secretVersionPath(project: string, secret: string, secretVersion: string): string;

Return a fully-qualified secretVersion resource name string.

Parameters

Name	Description
project	string
secret	string
secretVersion	string

Returns

Type	Description
string	{string} Resource name string.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.iam.v1.ISetIamPolicyRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ISetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ISetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.iam.v1.ITestIamPermissionsRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ITestIamPermissionsRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.iam.v1.ITestIamPermissionsRequest
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

topicPath(project, topic)

topicPath(project: string, topic: string): string;

Return a fully-qualified topic resource name string.

Parameters

Name	Description
project	string
topic	string

Returns

Type	Description
string	{string} Resource name string.

updateSecret(request, options)

updateSecret(request?: protos.google.cloud.secretmanager.v1.IUpdateSecretRequest, options?: CallOptions): Promise<[protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IUpdateSecretRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IUpdateSecretRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IUpdateSecretRequest | undefined, {} | undefined]>

updateSecret(request, options, callback)

updateSecret(request: protos.google.cloud.secretmanager.v1.IUpdateSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IUpdateSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IUpdateSecretRequest
options	CallOptions
callback	Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IUpdateSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateSecret(request, callback)

updateSecret(request: protos.google.cloud.secretmanager.v1.IUpdateSecretRequest, callback: Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IUpdateSecretRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.secretmanager.v1.IUpdateSecretRequest
callback	Callback<protos.google.cloud.secretmanager.v1.ISecret, protos.google.cloud.secretmanager.v1.IUpdateSecretRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void