Autokey

google.cloud.kms.v1. Autokey

Represents an Autokey

Constructor

new Autokey(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

createKeyHandle(request, callback) → {undefined}

Calls CreateKeyHandle.

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

CreateKeyHandleRequest message or plain object

callback google.cloud.kms.v1.Autokey.CreateKeyHandleCallback

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

Returns:
Type Description
undefined

createKeyHandle(request) → {Promise.<google.longrunning.Operation>}

Calls CreateKeyHandle.

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

CreateKeyHandleRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getKeyHandle(request, callback) → {undefined}

Calls GetKeyHandle.

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

GetKeyHandleRequest message or plain object

callback google.cloud.kms.v1.Autokey.GetKeyHandleCallback

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

Returns:
Type Description
undefined

getKeyHandle(request) → {Promise.<google.cloud.kms.v1.KeyHandle>}

Calls GetKeyHandle.

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

GetKeyHandleRequest message or plain object

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

Promise

listKeyHandles(request, callback) → {undefined}

Calls ListKeyHandles.

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

ListKeyHandlesRequest message or plain object

callback google.cloud.kms.v1.Autokey.ListKeyHandlesCallback

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

Returns:
Type Description
undefined

listKeyHandles(request) → {Promise.<google.cloud.kms.v1.ListKeyHandlesResponse>}

Calls ListKeyHandles.

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

ListKeyHandlesRequest message or plain object

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

Promise

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

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

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

Type Definitions

CreateKeyHandleCallback(error, responseopt)

Callback as used by createKeyHandle.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

GetKeyHandleCallback(error, responseopt)

Callback as used by getKeyHandle.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

KeyHandle

ListKeyHandlesCallback(error, responseopt)

Callback as used by listKeyHandles.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

ListKeyHandlesResponse