Class protos.google.cloud.kms.v1.Autokey (4.3.0)

Represents an Autokey

Inheritance

$protobuf.rpc.Service > protos.google.cloud.kms.v1.Autokey

Package

@google-cloud/kms

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Autokey service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

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

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

createKeyHandle(request, callback)

public createKeyHandle(request: google.cloud.kms.v1.ICreateKeyHandleRequest, callback: google.cloud.kms.v1.Autokey.CreateKeyHandleCallback): void;

Calls CreateKeyHandle.

Parameters
Name Description
request ICreateKeyHandleRequest

CreateKeyHandleRequest message or plain object
callback CreateKeyHandleCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createKeyHandle(request)

public createKeyHandle(request: google.cloud.kms.v1.ICreateKeyHandleRequest): Promise<google.longrunning.Operation>;

Calls CreateKeyHandle.

Parameter
Name Description
request ICreateKeyHandleRequest

CreateKeyHandleRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getKeyHandle(request, callback)

public getKeyHandle(request: google.cloud.kms.v1.IGetKeyHandleRequest, callback: google.cloud.kms.v1.Autokey.GetKeyHandleCallback): void;

Calls GetKeyHandle.

Parameters
Name Description
request IGetKeyHandleRequest

GetKeyHandleRequest message or plain object
callback GetKeyHandleCallback

Node-style callback called with the error, if any, and KeyHandle
Returns
Type Description
void

getKeyHandle(request)

public getKeyHandle(request: google.cloud.kms.v1.IGetKeyHandleRequest): Promise<google.cloud.kms.v1.KeyHandle>;

Calls GetKeyHandle.

Parameter
Name Description
request IGetKeyHandleRequest

GetKeyHandleRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.KeyHandle>

Promise

listKeyHandles(request, callback)

public listKeyHandles(request: google.cloud.kms.v1.IListKeyHandlesRequest, callback: google.cloud.kms.v1.Autokey.ListKeyHandlesCallback): void;

Calls ListKeyHandles.

Parameters
Name Description
request IListKeyHandlesRequest

ListKeyHandlesRequest message or plain object
callback ListKeyHandlesCallback

Node-style callback called with the error, if any, and ListKeyHandlesResponse
Returns
Type Description
void

listKeyHandles(request)

public listKeyHandles(request: google.cloud.kms.v1.IListKeyHandlesRequest): Promise<google.cloud.kms.v1.ListKeyHandlesResponse>;

Calls ListKeyHandles.

Parameter
Name Description
request IListKeyHandlesRequest

ListKeyHandlesRequest message or plain object
Returns
Type Description
Promise<google.cloud.kms.v1.ListKeyHandlesResponse>

Promise