Class protos.google.cloud.secretmanager.v1.SecretManagerService (3.12.0)

Represents a SecretManagerService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.secretmanager.v1.SecretManagerService

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new SecretManagerService service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

accessSecretVersion(request, callback)

public accessSecretVersion(request: google.cloud.secretmanager.v1.IAccessSecretVersionRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersionCallback): void;

Calls AccessSecretVersion.

Parameters

Name	Description
request	`IAccessSecretVersionRequest` AccessSecretVersionRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersionCallback` Node-style callback called with the error, if any, and AccessSecretVersionResponse

Returns

Type	Description
void

accessSecretVersion(request)

public accessSecretVersion(request: google.cloud.secretmanager.v1.IAccessSecretVersionRequest): Promise<google.cloud.secretmanager.v1.AccessSecretVersionResponse>;

Calls AccessSecretVersion.

Parameter

Name	Description
request	`IAccessSecretVersionRequest` AccessSecretVersionRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.AccessSecretVersionResponse>	Promise

addSecretVersion(request, callback)

public addSecretVersion(request: google.cloud.secretmanager.v1.IAddSecretVersionRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersionCallback): void;

Calls AddSecretVersion.

Parameters

Name	Description
request	`IAddSecretVersionRequest` AddSecretVersionRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersionCallback` Node-style callback called with the error, if any, and SecretVersion

Returns

Type	Description
void

addSecretVersion(request)

public addSecretVersion(request: google.cloud.secretmanager.v1.IAddSecretVersionRequest): Promise<google.cloud.secretmanager.v1.SecretVersion>;

Calls AddSecretVersion.

Parameter

Name	Description
request	`IAddSecretVersionRequest` AddSecretVersionRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.SecretVersion>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): SecretManagerService;

Creates new SecretManagerService service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

Type	Description
SecretManagerService	RPC service. Useful where requests and/or responses are streamed.

createSecret(request, callback)

public createSecret(request: google.cloud.secretmanager.v1.ICreateSecretRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.CreateSecretCallback): void;

Calls CreateSecret.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.ICreateSecretRequest` CreateSecretRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.CreateSecretCallback` Node-style callback called with the error, if any, and Secret

Returns

Type	Description
void

createSecret(request)

public createSecret(request: google.cloud.secretmanager.v1.ICreateSecretRequest): Promise<google.cloud.secretmanager.v1.Secret>;

Calls CreateSecret.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.ICreateSecretRequest` CreateSecretRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.Secret>	Promise

deleteSecret(request, callback)

public deleteSecret(request: google.cloud.secretmanager.v1.IDeleteSecretRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.DeleteSecretCallback): void;

Calls DeleteSecret.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.IDeleteSecretRequest` DeleteSecretRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.DeleteSecretCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteSecret(request)

public deleteSecret(request: google.cloud.secretmanager.v1.IDeleteSecretRequest): Promise<google.protobuf.Empty>;

Calls DeleteSecret.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.IDeleteSecretRequest` DeleteSecretRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

destroySecretVersion(request, callback)

public destroySecretVersion(request: google.cloud.secretmanager.v1.IDestroySecretVersionRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersionCallback): void;

Calls DestroySecretVersion.

Parameters

Name	Description
request	`IDestroySecretVersionRequest` DestroySecretVersionRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersionCallback` Node-style callback called with the error, if any, and SecretVersion

Returns

Type	Description
void

destroySecretVersion(request)

public destroySecretVersion(request: google.cloud.secretmanager.v1.IDestroySecretVersionRequest): Promise<google.cloud.secretmanager.v1.SecretVersion>;

Calls DestroySecretVersion.

Parameter

Name	Description
request	`IDestroySecretVersionRequest` DestroySecretVersionRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.SecretVersion>	Promise

disableSecretVersion(request, callback)

public disableSecretVersion(request: google.cloud.secretmanager.v1.IDisableSecretVersionRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersionCallback): void;

Calls DisableSecretVersion.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.IDisableSecretVersionRequest` DisableSecretVersionRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersionCallback` Node-style callback called with the error, if any, and SecretVersion

Returns

Type	Description
void

disableSecretVersion(request)

public disableSecretVersion(request: google.cloud.secretmanager.v1.IDisableSecretVersionRequest): Promise<google.cloud.secretmanager.v1.SecretVersion>;

Calls DisableSecretVersion.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.IDisableSecretVersionRequest` DisableSecretVersionRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.SecretVersion>	Promise

enableSecretVersion(request, callback)

public enableSecretVersion(request: google.cloud.secretmanager.v1.IEnableSecretVersionRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersionCallback): void;

Calls EnableSecretVersion.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.IEnableSecretVersionRequest` EnableSecretVersionRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersionCallback` Node-style callback called with the error, if any, and SecretVersion

Returns

Type	Description
void

enableSecretVersion(request)

public enableSecretVersion(request: google.cloud.secretmanager.v1.IEnableSecretVersionRequest): Promise<google.cloud.secretmanager.v1.SecretVersion>;

Calls EnableSecretVersion.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.IEnableSecretVersionRequest` EnableSecretVersionRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.SecretVersion>	Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters

Name	Description
request	`google.iam.v1.IGetIamPolicyRequest` GetIamPolicyRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.GetIamPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns

Type	Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter

Name	Description
request	`google.iam.v1.IGetIamPolicyRequest` GetIamPolicyRequest message or plain object

Returns

Type	Description
Promise<google.iam.v1.Policy>	Promise

getSecret(request, callback)

public getSecret(request: google.cloud.secretmanager.v1.IGetSecretRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.GetSecretCallback): void;

Calls GetSecret.

Parameters

Name	Description
request	`IGetSecretRequest` GetSecretRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.GetSecretCallback` Node-style callback called with the error, if any, and Secret

Returns

Type	Description
void

getSecret(request)

public getSecret(request: google.cloud.secretmanager.v1.IGetSecretRequest): Promise<google.cloud.secretmanager.v1.Secret>;

Calls GetSecret.

Parameter

Name	Description
request	`IGetSecretRequest` GetSecretRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.Secret>	Promise

getSecretVersion(request, callback)

public getSecretVersion(request: google.cloud.secretmanager.v1.IGetSecretVersionRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersionCallback): void;

Calls GetSecretVersion.

Parameters

Name	Description
request	`IGetSecretVersionRequest` GetSecretVersionRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersionCallback` Node-style callback called with the error, if any, and SecretVersion

Returns

Type	Description
void

getSecretVersion(request)

public getSecretVersion(request: google.cloud.secretmanager.v1.IGetSecretVersionRequest): Promise<google.cloud.secretmanager.v1.SecretVersion>;

Calls GetSecretVersion.

Parameter

Name	Description
request	`IGetSecretVersionRequest` GetSecretVersionRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.SecretVersion>	Promise

listSecrets(request, callback)

public listSecrets(request: google.cloud.secretmanager.v1.IListSecretsRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.ListSecretsCallback): void;

Calls ListSecrets.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.IListSecretsRequest` ListSecretsRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.ListSecretsCallback` Node-style callback called with the error, if any, and ListSecretsResponse

Returns

Type	Description
void

listSecrets(request)

public listSecrets(request: google.cloud.secretmanager.v1.IListSecretsRequest): Promise<google.cloud.secretmanager.v1.ListSecretsResponse>;

Calls ListSecrets.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.IListSecretsRequest` ListSecretsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.ListSecretsResponse>	Promise

listSecretVersions(request, callback)

public listSecretVersions(request: google.cloud.secretmanager.v1.IListSecretVersionsRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersionsCallback): void;

Calls ListSecretVersions.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.IListSecretVersionsRequest` ListSecretVersionsRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersionsCallback` Node-style callback called with the error, if any, and ListSecretVersionsResponse

Returns

Type	Description
void

listSecretVersions(request)

public listSecretVersions(request: google.cloud.secretmanager.v1.IListSecretVersionsRequest): Promise<google.cloud.secretmanager.v1.ListSecretVersionsResponse>;

Calls ListSecretVersions.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.IListSecretVersionsRequest` ListSecretVersionsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.ListSecretVersionsResponse>	Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters

Name	Description
request	`google.iam.v1.ISetIamPolicyRequest` SetIamPolicyRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.SetIamPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns

Type	Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter

Name	Description
request	`google.iam.v1.ISetIamPolicyRequest` SetIamPolicyRequest message or plain object

Returns

Type	Description
Promise<google.iam.v1.Policy>	Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters

Name	Description
request	`google.iam.v1.ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.TestIamPermissionsCallback` Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns

Type	Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter

Name	Description
request	`google.iam.v1.ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object

Returns

Type	Description
Promise<google.iam.v1.TestIamPermissionsResponse>	Promise

updateSecret(request, callback)

public updateSecret(request: google.cloud.secretmanager.v1.IUpdateSecretRequest, callback: google.cloud.secretmanager.v1.SecretManagerService.UpdateSecretCallback): void;

Calls UpdateSecret.

Parameters

Name	Description
request	`google.cloud.secretmanager.v1.IUpdateSecretRequest` UpdateSecretRequest message or plain object
callback	`google.cloud.secretmanager.v1.SecretManagerService.UpdateSecretCallback` Node-style callback called with the error, if any, and Secret

Returns

Type	Description
void

updateSecret(request)

public updateSecret(request: google.cloud.secretmanager.v1.IUpdateSecretRequest): Promise<google.cloud.secretmanager.v1.Secret>;

Calls UpdateSecret.

Parameter

Name	Description
request	`google.cloud.secretmanager.v1.IUpdateSecretRequest` UpdateSecretRequest message or plain object

Returns

Type	Description
Promise<google.cloud.secretmanager.v1.Secret>	Promise