SecretManagerService

google.cloud.secrets.v1beta1. SecretManagerService

Represents a SecretManagerService

Constructor

new SecretManagerService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new SecretManagerService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

accessSecretVersion(request, callback) → {undefined}

Calls AccessSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IAccessSecretVersionRequest

AccessSecretVersionRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.AccessSecretVersionCallback

Node-style callback called with the error, if any, and AccessSecretVersionResponse

Returns:
Type Description
undefined

accessSecretVersion(request) → {Promise.<google.cloud.secrets.v1beta1.AccessSecretVersionResponse>}

Calls AccessSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IAccessSecretVersionRequest

AccessSecretVersionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.AccessSecretVersionResponse>

Promise

addSecretVersion(request, callback) → {undefined}

Calls AddSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IAddSecretVersionRequest

AddSecretVersionRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.AddSecretVersionCallback

Node-style callback called with the error, if any, and SecretVersion

Returns:
Type Description
undefined

addSecretVersion(request) → {Promise.<google.cloud.secrets.v1beta1.SecretVersion>}

Calls AddSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IAddSecretVersionRequest

AddSecretVersionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.SecretVersion>

Promise

createSecret(request, callback) → {undefined}

Calls CreateSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.ICreateSecretRequest

CreateSecretRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.CreateSecretCallback

Node-style callback called with the error, if any, and Secret

Returns:
Type Description
undefined

createSecret(request) → {Promise.<google.cloud.secrets.v1beta1.Secret>}

Calls CreateSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.ICreateSecretRequest

CreateSecretRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.Secret>

Promise

deleteSecret(request, callback) → {undefined}

Calls DeleteSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IDeleteSecretRequest

DeleteSecretRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.DeleteSecretCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteSecret(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IDeleteSecretRequest

DeleteSecretRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

destroySecretVersion(request, callback) → {undefined}

Calls DestroySecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IDestroySecretVersionRequest

DestroySecretVersionRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.DestroySecretVersionCallback

Node-style callback called with the error, if any, and SecretVersion

Returns:
Type Description
undefined

destroySecretVersion(request) → {Promise.<google.cloud.secrets.v1beta1.SecretVersion>}

Calls DestroySecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IDestroySecretVersionRequest

DestroySecretVersionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.SecretVersion>

Promise

disableSecretVersion(request, callback) → {undefined}

Calls DisableSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IDisableSecretVersionRequest

DisableSecretVersionRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.DisableSecretVersionCallback

Node-style callback called with the error, if any, and SecretVersion

Returns:
Type Description
undefined

disableSecretVersion(request) → {Promise.<google.cloud.secrets.v1beta1.SecretVersion>}

Calls DisableSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IDisableSecretVersionRequest

DisableSecretVersionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.SecretVersion>

Promise

enableSecretVersion(request, callback) → {undefined}

Calls EnableSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IEnableSecretVersionRequest

EnableSecretVersionRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.EnableSecretVersionCallback

Node-style callback called with the error, if any, and SecretVersion

Returns:
Type Description
undefined

enableSecretVersion(request) → {Promise.<google.cloud.secrets.v1beta1.SecretVersion>}

Calls EnableSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IEnableSecretVersionRequest

EnableSecretVersionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.SecretVersion>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

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

Promise

getSecret(request, callback) → {undefined}

Calls GetSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IGetSecretRequest

GetSecretRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.GetSecretCallback

Node-style callback called with the error, if any, and Secret

Returns:
Type Description
undefined

getSecret(request) → {Promise.<google.cloud.secrets.v1beta1.Secret>}

Calls GetSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IGetSecretRequest

GetSecretRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.Secret>

Promise

getSecretVersion(request, callback) → {undefined}

Calls GetSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IGetSecretVersionRequest

GetSecretVersionRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.GetSecretVersionCallback

Node-style callback called with the error, if any, and SecretVersion

Returns:
Type Description
undefined

getSecretVersion(request) → {Promise.<google.cloud.secrets.v1beta1.SecretVersion>}

Calls GetSecretVersion.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IGetSecretVersionRequest

GetSecretVersionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.SecretVersion>

Promise

listSecretVersions(request, callback) → {undefined}

Calls ListSecretVersions.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IListSecretVersionsRequest

ListSecretVersionsRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.ListSecretVersionsCallback

Node-style callback called with the error, if any, and ListSecretVersionsResponse

Returns:
Type Description
undefined

listSecretVersions(request) → {Promise.<google.cloud.secrets.v1beta1.ListSecretVersionsResponse>}

Calls ListSecretVersions.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IListSecretVersionsRequest

ListSecretVersionsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.ListSecretVersionsResponse>

Promise

listSecrets(request, callback) → {undefined}

Calls ListSecrets.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IListSecretsRequest

ListSecretsRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.ListSecretsCallback

Node-style callback called with the error, if any, and ListSecretsResponse

Returns:
Type Description
undefined

listSecrets(request) → {Promise.<google.cloud.secrets.v1beta1.ListSecretsResponse>}

Calls ListSecrets.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IListSecretsRequest

ListSecretsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.ListSecretsResponse>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

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

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

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

Promise

updateSecret(request, callback) → {undefined}

Calls UpdateSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IUpdateSecretRequest

UpdateSecretRequest message or plain object

callback google.cloud.secrets.v1beta1.SecretManagerService.UpdateSecretCallback

Node-style callback called with the error, if any, and Secret

Returns:
Type Description
undefined

updateSecret(request) → {Promise.<google.cloud.secrets.v1beta1.Secret>}

Calls UpdateSecret.

Parameters:
Name Type Description
request google.cloud.secrets.v1beta1.IUpdateSecretRequest

UpdateSecretRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.secrets.v1beta1.Secret>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {SecretManagerService}

Creates new SecretManagerService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
SecretManagerService

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

Type Definitions

AccessSecretVersionCallback(error, responseopt)

Callback as used by accessSecretVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.AccessSecretVersionResponse <optional>

AccessSecretVersionResponse

AddSecretVersionCallback(error, responseopt)

Callback as used by addSecretVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.SecretVersion <optional>

SecretVersion

CreateSecretCallback(error, responseopt)

Callback as used by createSecret.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.Secret <optional>

Secret

DeleteSecretCallback(error, responseopt)

Callback as used by deleteSecret.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DestroySecretVersionCallback(error, responseopt)

Callback as used by destroySecretVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.SecretVersion <optional>

SecretVersion

DisableSecretVersionCallback(error, responseopt)

Callback as used by disableSecretVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.SecretVersion <optional>

SecretVersion

EnableSecretVersionCallback(error, responseopt)

Callback as used by enableSecretVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.SecretVersion <optional>

SecretVersion

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

GetSecretCallback(error, responseopt)

Callback as used by getSecret.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.Secret <optional>

Secret

GetSecretVersionCallback(error, responseopt)

Callback as used by getSecretVersion.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.SecretVersion <optional>

SecretVersion

ListSecretVersionsCallback(error, responseopt)

Callback as used by listSecretVersions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.ListSecretVersionsResponse <optional>

ListSecretVersionsResponse

ListSecretsCallback(error, responseopt)

Callback as used by listSecrets.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.ListSecretsResponse <optional>

ListSecretsResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UpdateSecretCallback(error, responseopt)

Callback as used by updateSecret.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.secrets.v1beta1.Secret <optional>

Secret