Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
* * v1beta1
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.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
secretManagerServiceStub
secretManagerServiceStub?: Promise<{
[name: string]: Function;
}>;
servicePath
static get servicePath(): string;
The DNS address for this API service.
Methods
accessSecretVersion(request, options)
accessSecretVersion(request: protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.IAccessSecretVersionResponse, (protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.IAccessSecretVersionResponse, (protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest | undefined), {} | undefined]> | |
accessSecretVersion(request, options, callback)
accessSecretVersion(request: protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.IAccessSecretVersionResponse, protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.IAccessSecretVersionResponse, protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
accessSecretVersion(request, callback)
accessSecretVersion(request: protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.IAccessSecretVersionResponse, protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.IAccessSecretVersionResponse, protos.google.cloud.secrets.v1beta1.IAccessSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
addSecretVersion(request, options)
addSecretVersion(request: protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest | undefined, {} | undefined]> | |
addSecretVersion(request, options, callback)
addSecretVersion(request: protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
addSecretVersion(request, callback)
addSecretVersion(request: protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IAddSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
close()
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.secrets.v1beta1.ICreateSecretRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.ICreateSecretRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.ICreateSecretRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.ICreateSecretRequest | undefined, {} | undefined]> | |
createSecret(request, options, callback)
createSecret(request: protos.google.cloud.secrets.v1beta1.ICreateSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.ICreateSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.ICreateSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.ICreateSecretRequest | null | undefined, {} | null | undefined>
|
Returns
createSecret(request, callback)
createSecret(request: protos.google.cloud.secrets.v1beta1.ICreateSecretRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.ICreateSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.ICreateSecretRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.ICreateSecretRequest | null | undefined, {} | null | undefined>
|
Returns
deleteSecret(request, options)
deleteSecret(request: protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest | undefined, {} | undefined]> | |
deleteSecret(request, options, callback)
deleteSecret(request: protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest | null | undefined, {} | null | undefined>
|
Returns
deleteSecret(request, callback)
deleteSecret(request: protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.secrets.v1beta1.IDeleteSecretRequest | null | undefined, {} | null | undefined>
|
Returns
destroySecretVersion(request, options)
destroySecretVersion(request: protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, (protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, (protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest | undefined), {} | undefined]> | |
destroySecretVersion(request, options, callback)
destroySecretVersion(request: protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
destroySecretVersion(request, callback)
destroySecretVersion(request: protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDestroySecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
disableSecretVersion(request, options)
disableSecretVersion(request: protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, (protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, (protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest | undefined), {} | undefined]> | |
disableSecretVersion(request, options, callback)
disableSecretVersion(request: protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
disableSecretVersion(request, callback)
disableSecretVersion(request: protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IDisableSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
enableSecretVersion(request, options)
enableSecretVersion(request: protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, (protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, (protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest | undefined), {} | undefined]> | |
enableSecretVersion(request, options, callback)
enableSecretVersion(request: protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
enableSecretVersion(request, callback)
enableSecretVersion(request: protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IEnableSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
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
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
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
getSecret(request, options)
getSecret(request: protos.google.cloud.secrets.v1beta1.IGetSecretRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IGetSecretRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IGetSecretRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IGetSecretRequest | undefined, {} | undefined]> | |
getSecret(request, options, callback)
getSecret(request: protos.google.cloud.secrets.v1beta1.IGetSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IGetSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IGetSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IGetSecretRequest | null | undefined, {} | null | undefined>
|
Returns
getSecret(request, callback)
getSecret(request: protos.google.cloud.secrets.v1beta1.IGetSecretRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IGetSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IGetSecretRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IGetSecretRequest | null | undefined, {} | null | undefined>
|
Returns
getSecretVersion(request, options)
getSecretVersion(request: protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest | undefined, {} | undefined]> | |
getSecretVersion(request, options, callback)
getSecretVersion(request: protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
getSecretVersion(request, callback)
getSecretVersion(request: protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecretVersion, protos.google.cloud.secrets.v1beta1.IGetSecretVersionRequest | null | undefined, {} | null | undefined>
|
Returns
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.secrets.v1beta1.IListSecretsRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecret[], protos.google.cloud.secrets.v1beta1.IListSecretsRequest | null, protos.google.cloud.secrets.v1beta1.IListSecretsResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IListSecretsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecret[], protos.google.cloud.secrets.v1beta1.IListSecretsRequest | null, protos.google.cloud.secrets.v1beta1.IListSecretsResponse]> | |
listSecrets(request, options, callback)
listSecrets(request: protos.google.cloud.secrets.v1beta1.IListSecretsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretsRequest, protos.google.cloud.secrets.v1beta1.IListSecretsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecret>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IListSecretsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretsRequest, protos.google.cloud.secrets.v1beta1.IListSecretsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecret>
|
Returns
listSecrets(request, callback)
listSecrets(request: protos.google.cloud.secrets.v1beta1.IListSecretsRequest, callback: PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretsRequest, protos.google.cloud.secrets.v1beta1.IListSecretsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecret>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IListSecretsRequest
|
callback |
PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretsRequest, protos.google.cloud.secrets.v1beta1.IListSecretsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecret>
|
Returns
listSecretsAsync(request, options)
listSecretsAsync(request?: protos.google.cloud.secrets.v1beta1.IListSecretsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.secrets.v1beta1.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.secrets.v1beta1.IListSecretsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.secrets.v1beta1.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.
|
Example
const iterable = client.listSecretsAsync(request); for await (const response of iterable) { // process response }
listSecretsStream(request, options)
listSecretsStream(request?: protos.google.cloud.secrets.v1beta1.IListSecretsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.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.secrets.v1beta1.IListSecretVersionsRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion[], protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest | null, protos.google.cloud.secrets.v1beta1.IListSecretVersionsResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecretVersion[], protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest | null, protos.google.cloud.secrets.v1beta1.IListSecretVersionsResponse]> | |
listSecretVersions(request, options, callback)
listSecretVersions(request: protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, protos.google.cloud.secrets.v1beta1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecretVersion>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, protos.google.cloud.secrets.v1beta1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecretVersion>
|
Returns
listSecretVersions(request, callback)
listSecretVersions(request: protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, callback: PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, protos.google.cloud.secrets.v1beta1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecretVersion>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest
|
callback |
PaginationCallback<protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, protos.google.cloud.secrets.v1beta1.IListSecretVersionsResponse | null | undefined, protos.google.cloud.secrets.v1beta1.ISecretVersion>
|
Returns
listSecretVersionsAsync(request, options)
listSecretVersionsAsync(request?: protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.secrets.v1beta1.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.secrets.v1beta1.IListSecretVersionsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.secrets.v1beta1.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.
|
Example
const iterable = client.listSecretVersionsAsync(request); for await (const response of iterable) { // process response }
listSecretVersionsStream(request, options)
listSecretVersionsStream(request?: protos.google.cloud.secrets.v1beta1.IListSecretVersionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.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.
|
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.
|
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
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
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
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
updateSecret(request, options)
updateSecret(request: protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest, options?: CallOptions): Promise<[protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest | undefined, {} | undefined]> | |
updateSecret(request, options, callback)
updateSecret(request: protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest, options: CallOptions, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest | null | undefined, {} | null | undefined>
|
Returns
updateSecret(request, callback)
updateSecret(request: protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest, callback: Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest
|
callback |
Callback<protos.google.cloud.secrets.v1beta1.ISecret, protos.google.cloud.secrets.v1beta1.IUpdateSecretRequest | null | undefined, {} | null | undefined>
|
Returns