AutokeyAdmin

google.cloud.kms.v1. AutokeyAdmin

Represents an AutokeyAdmin

Constructor

new AutokeyAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new AutokeyAdmin 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

getAutokeyConfig(request, callback) → {undefined}

Calls GetAutokeyConfig.

Parameters:
Name Type Description
request google.cloud.kms.v1.IGetAutokeyConfigRequest

GetAutokeyConfigRequest message or plain object

callback google.cloud.kms.v1.AutokeyAdmin.GetAutokeyConfigCallback

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

Returns:
Type Description
undefined

getAutokeyConfig(request) → {Promise.<google.cloud.kms.v1.AutokeyConfig>}

Calls GetAutokeyConfig.

Parameters:
Name Type Description
request google.cloud.kms.v1.IGetAutokeyConfigRequest

GetAutokeyConfigRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.kms.v1.AutokeyConfig>

Promise

showEffectiveAutokeyConfig(request, callback) → {undefined}

Calls ShowEffectiveAutokeyConfig.

Parameters:
Name Type Description
request google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest

ShowEffectiveAutokeyConfigRequest message or plain object

callback google.cloud.kms.v1.AutokeyAdmin.ShowEffectiveAutokeyConfigCallback

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

Returns:
Type Description
undefined

showEffectiveAutokeyConfig(request) → {Promise.<google.cloud.kms.v1.ShowEffectiveAutokeyConfigResponse>}

Calls ShowEffectiveAutokeyConfig.

Parameters:
Name Type Description
request google.cloud.kms.v1.IShowEffectiveAutokeyConfigRequest

ShowEffectiveAutokeyConfigRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.kms.v1.ShowEffectiveAutokeyConfigResponse>

Promise

updateAutokeyConfig(request, callback) → {undefined}

Calls UpdateAutokeyConfig.

Parameters:
Name Type Description
request google.cloud.kms.v1.IUpdateAutokeyConfigRequest

UpdateAutokeyConfigRequest message or plain object

callback google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfigCallback

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

Returns:
Type Description
undefined

updateAutokeyConfig(request) → {Promise.<google.cloud.kms.v1.AutokeyConfig>}

Calls UpdateAutokeyConfig.

Parameters:
Name Type Description
request google.cloud.kms.v1.IUpdateAutokeyConfigRequest

UpdateAutokeyConfigRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.kms.v1.AutokeyConfig>

Promise

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

Creates new AutokeyAdmin 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
AutokeyAdmin

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

Type Definitions

GetAutokeyConfigCallback(error, responseopt)

Callback as used by getAutokeyConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.kms.v1.AutokeyConfig <optional>

AutokeyConfig

ShowEffectiveAutokeyConfigCallback(error, responseopt)

Callback as used by showEffectiveAutokeyConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.kms.v1.ShowEffectiveAutokeyConfigResponse <optional>

ShowEffectiveAutokeyConfigResponse

UpdateAutokeyConfigCallback(error, responseopt)

Callback as used by updateAutokeyConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.kms.v1.AutokeyConfig <optional>

AutokeyConfig