EkmService

google.cloud.kms.v1. EkmService

Represents an EkmService

Constructor

new EkmService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

createEkmConnection(request, callback) → {undefined}

Calls CreateEkmConnection.

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

CreateEkmConnectionRequest message or plain object
callback google.cloud.kms.v1.EkmService.CreateEkmConnectionCallback

Node-style callback called with the error, if any, and EkmConnection
Returns:
Type Description
undefined

createEkmConnection(request) → {Promise.<google.cloud.kms.v1.EkmConnection>}

Calls CreateEkmConnection.

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

CreateEkmConnectionRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.EkmConnection>

Promise

getEkmConfig(request, callback) → {undefined}

Calls GetEkmConfig.

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

GetEkmConfigRequest message or plain object
callback google.cloud.kms.v1.EkmService.GetEkmConfigCallback

Node-style callback called with the error, if any, and EkmConfig
Returns:
Type Description
undefined

getEkmConfig(request) → {Promise.<google.cloud.kms.v1.EkmConfig>}

Calls GetEkmConfig.

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

GetEkmConfigRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.EkmConfig>

Promise

getEkmConnection(request, callback) → {undefined}

Calls GetEkmConnection.

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

GetEkmConnectionRequest message or plain object
callback google.cloud.kms.v1.EkmService.GetEkmConnectionCallback

Node-style callback called with the error, if any, and EkmConnection
Returns:
Type Description
undefined

getEkmConnection(request) → {Promise.<google.cloud.kms.v1.EkmConnection>}

Calls GetEkmConnection.

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

GetEkmConnectionRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.EkmConnection>

Promise

listEkmConnections(request, callback) → {undefined}

Calls ListEkmConnections.

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

ListEkmConnectionsRequest message or plain object
callback google.cloud.kms.v1.EkmService.ListEkmConnectionsCallback

Node-style callback called with the error, if any, and ListEkmConnectionsResponse
Returns:
Type Description
undefined

listEkmConnections(request) → {Promise.<google.cloud.kms.v1.ListEkmConnectionsResponse>}

Calls ListEkmConnections.

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

ListEkmConnectionsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.ListEkmConnectionsResponse>

Promise

updateEkmConfig(request, callback) → {undefined}

Calls UpdateEkmConfig.

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

UpdateEkmConfigRequest message or plain object
callback google.cloud.kms.v1.EkmService.UpdateEkmConfigCallback

Node-style callback called with the error, if any, and EkmConfig
Returns:
Type Description
undefined

updateEkmConfig(request) → {Promise.<google.cloud.kms.v1.EkmConfig>}

Calls UpdateEkmConfig.

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

UpdateEkmConfigRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.EkmConfig>

Promise

updateEkmConnection(request, callback) → {undefined}

Calls UpdateEkmConnection.

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

UpdateEkmConnectionRequest message or plain object
callback google.cloud.kms.v1.EkmService.UpdateEkmConnectionCallback

Node-style callback called with the error, if any, and EkmConnection
Returns:
Type Description
undefined

updateEkmConnection(request) → {Promise.<google.cloud.kms.v1.EkmConnection>}

Calls UpdateEkmConnection.

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

UpdateEkmConnectionRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.EkmConnection>

Promise

verifyConnectivity(request, callback) → {undefined}

Calls VerifyConnectivity.

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

VerifyConnectivityRequest message or plain object
callback google.cloud.kms.v1.EkmService.VerifyConnectivityCallback

Node-style callback called with the error, if any, and VerifyConnectivityResponse
Returns:
Type Description
undefined

verifyConnectivity(request) → {Promise.<google.cloud.kms.v1.VerifyConnectivityResponse>}

Calls VerifyConnectivity.

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

VerifyConnectivityRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.kms.v1.VerifyConnectivityResponse>

Promise

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

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

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

Type Definitions

CreateEkmConnectionCallback(error, responseopt)

Callback as used by createEkmConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.EkmConnection <optional>

EkmConnection

GetEkmConfigCallback(error, responseopt)

Callback as used by getEkmConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.EkmConfig <optional>

EkmConfig

GetEkmConnectionCallback(error, responseopt)

Callback as used by getEkmConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.EkmConnection <optional>

EkmConnection

ListEkmConnectionsCallback(error, responseopt)

Callback as used by listEkmConnections.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.ListEkmConnectionsResponse <optional>

ListEkmConnectionsResponse

UpdateEkmConfigCallback(error, responseopt)

Callback as used by updateEkmConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.EkmConfig <optional>

EkmConfig

UpdateEkmConnectionCallback(error, responseopt)

Callback as used by updateEkmConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.EkmConnection <optional>

EkmConnection

VerifyConnectivityCallback(error, responseopt)

Callback as used by verifyConnectivity.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.kms.v1.VerifyConnectivityResponse <optional>

VerifyConnectivityResponse