Class protos.google.cloud.kms.v1.HsmManagement (5.3.0)

Represents a HsmManagement

Inheritance

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

Package

@google-cloud/kms

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new HsmManagement service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

approveSingleTenantHsmInstanceProposal(request, callback)

public approveSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest, callback: google.cloud.kms.v1.HsmManagement.ApproveSingleTenantHsmInstanceProposalCallback): void;

Calls ApproveSingleTenantHsmInstanceProposal.

Parameters
Name Description
request IApproveSingleTenantHsmInstanceProposalRequest

ApproveSingleTenantHsmInstanceProposalRequest message or plain object

callback ApproveSingleTenantHsmInstanceProposalCallback

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

Returns
Type Description
void

approveSingleTenantHsmInstanceProposal(request)

public approveSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest): Promise<google.cloud.kms.v1.ApproveSingleTenantHsmInstanceProposalResponse>;

Calls ApproveSingleTenantHsmInstanceProposal.

Parameter
Name Description
request IApproveSingleTenantHsmInstanceProposalRequest

ApproveSingleTenantHsmInstanceProposalRequest message or plain object

Returns
Type Description
Promise<google.cloud.kms.v1.ApproveSingleTenantHsmInstanceProposalResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

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

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

createSingleTenantHsmInstance(request, callback)

public createSingleTenantHsmInstance(request: google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, callback: google.cloud.kms.v1.HsmManagement.CreateSingleTenantHsmInstanceCallback): void;

Calls CreateSingleTenantHsmInstance.

Parameters
Name Description
request ICreateSingleTenantHsmInstanceRequest

CreateSingleTenantHsmInstanceRequest message or plain object

callback CreateSingleTenantHsmInstanceCallback

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

Returns
Type Description
void

createSingleTenantHsmInstance(request)

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

Calls CreateSingleTenantHsmInstance.

Parameter
Name Description
request ICreateSingleTenantHsmInstanceRequest

CreateSingleTenantHsmInstanceRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createSingleTenantHsmInstanceProposal(request, callback)

public createSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, callback: google.cloud.kms.v1.HsmManagement.CreateSingleTenantHsmInstanceProposalCallback): void;

Calls CreateSingleTenantHsmInstanceProposal.

Parameters
Name Description
request ICreateSingleTenantHsmInstanceProposalRequest

CreateSingleTenantHsmInstanceProposalRequest message or plain object

callback CreateSingleTenantHsmInstanceProposalCallback

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

Returns
Type Description
void

createSingleTenantHsmInstanceProposal(request)

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

Calls CreateSingleTenantHsmInstanceProposal.

Parameter
Name Description
request ICreateSingleTenantHsmInstanceProposalRequest

CreateSingleTenantHsmInstanceProposalRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteSingleTenantHsmInstanceProposal(request, callback)

public deleteSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, callback: google.cloud.kms.v1.HsmManagement.DeleteSingleTenantHsmInstanceProposalCallback): void;

Calls DeleteSingleTenantHsmInstanceProposal.

Parameters
Name Description
request IDeleteSingleTenantHsmInstanceProposalRequest

DeleteSingleTenantHsmInstanceProposalRequest message or plain object

callback DeleteSingleTenantHsmInstanceProposalCallback

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

Returns
Type Description
void

deleteSingleTenantHsmInstanceProposal(request)

public deleteSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest): Promise<google.protobuf.Empty>;

Calls DeleteSingleTenantHsmInstanceProposal.

Parameter
Name Description
request IDeleteSingleTenantHsmInstanceProposalRequest

DeleteSingleTenantHsmInstanceProposalRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

executeSingleTenantHsmInstanceProposal(request, callback)

public executeSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, callback: google.cloud.kms.v1.HsmManagement.ExecuteSingleTenantHsmInstanceProposalCallback): void;

Calls ExecuteSingleTenantHsmInstanceProposal.

Parameters
Name Description
request IExecuteSingleTenantHsmInstanceProposalRequest

ExecuteSingleTenantHsmInstanceProposalRequest message or plain object

callback ExecuteSingleTenantHsmInstanceProposalCallback

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

Returns
Type Description
void

executeSingleTenantHsmInstanceProposal(request)

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

Calls ExecuteSingleTenantHsmInstanceProposal.

Parameter
Name Description
request IExecuteSingleTenantHsmInstanceProposalRequest

ExecuteSingleTenantHsmInstanceProposalRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getSingleTenantHsmInstance(request, callback)

public getSingleTenantHsmInstance(request: google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest, callback: google.cloud.kms.v1.HsmManagement.GetSingleTenantHsmInstanceCallback): void;

Calls GetSingleTenantHsmInstance.

Parameters
Name Description
request IGetSingleTenantHsmInstanceRequest

GetSingleTenantHsmInstanceRequest message or plain object

callback GetSingleTenantHsmInstanceCallback

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

Returns
Type Description
void

getSingleTenantHsmInstance(request)

public getSingleTenantHsmInstance(request: google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest): Promise<google.cloud.kms.v1.SingleTenantHsmInstance>;

Calls GetSingleTenantHsmInstance.

Parameter
Name Description
request IGetSingleTenantHsmInstanceRequest

GetSingleTenantHsmInstanceRequest message or plain object

Returns
Type Description
Promise<google.cloud.kms.v1.SingleTenantHsmInstance>

Promise

getSingleTenantHsmInstanceProposal(request, callback)

public getSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest, callback: google.cloud.kms.v1.HsmManagement.GetSingleTenantHsmInstanceProposalCallback): void;

Calls GetSingleTenantHsmInstanceProposal.

Parameters
Name Description
request IGetSingleTenantHsmInstanceProposalRequest

GetSingleTenantHsmInstanceProposalRequest message or plain object

callback GetSingleTenantHsmInstanceProposalCallback

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

Returns
Type Description
void

getSingleTenantHsmInstanceProposal(request)

public getSingleTenantHsmInstanceProposal(request: google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest): Promise<google.cloud.kms.v1.SingleTenantHsmInstanceProposal>;

Calls GetSingleTenantHsmInstanceProposal.

Parameter
Name Description
request IGetSingleTenantHsmInstanceProposalRequest

GetSingleTenantHsmInstanceProposalRequest message or plain object

Returns
Type Description
Promise<google.cloud.kms.v1.SingleTenantHsmInstanceProposal>

Promise

listSingleTenantHsmInstanceProposals(request, callback)

public listSingleTenantHsmInstanceProposals(request: google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, callback: google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstanceProposalsCallback): void;

Calls ListSingleTenantHsmInstanceProposals.

Parameters
Name Description
request IListSingleTenantHsmInstanceProposalsRequest

ListSingleTenantHsmInstanceProposalsRequest message or plain object

callback ListSingleTenantHsmInstanceProposalsCallback

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

Returns
Type Description
void

listSingleTenantHsmInstanceProposals(request)

public listSingleTenantHsmInstanceProposals(request: google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest): Promise<google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse>;

Calls ListSingleTenantHsmInstanceProposals.

Parameter
Name Description
request IListSingleTenantHsmInstanceProposalsRequest

ListSingleTenantHsmInstanceProposalsRequest message or plain object

Returns
Type Description
Promise<google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse>

Promise

listSingleTenantHsmInstances(request, callback)

public listSingleTenantHsmInstances(request: google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, callback: google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstancesCallback): void;

Calls ListSingleTenantHsmInstances.

Parameters
Name Description
request IListSingleTenantHsmInstancesRequest

ListSingleTenantHsmInstancesRequest message or plain object

callback ListSingleTenantHsmInstancesCallback

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

Returns
Type Description
void

listSingleTenantHsmInstances(request)

public listSingleTenantHsmInstances(request: google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest): Promise<google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse>;

Calls ListSingleTenantHsmInstances.

Parameter
Name Description
request IListSingleTenantHsmInstancesRequest

ListSingleTenantHsmInstancesRequest message or plain object

Returns
Type Description
Promise<google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse>

Promise