Cloud KMS V1 Client - Class CreateSingleTenantHsmInstanceProposalRequest (2.6.0)

Reference documentation and code samples for the Cloud KMS V1 Client class CreateSingleTenantHsmInstanceProposalRequest.

Request message for HsmManagement.CreateSingleTenantHsmInstanceProposal.

Generated from protobuf message google.cloud.kms.v1.CreateSingleTenantHsmInstanceProposalRequest

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals.

↳ single_tenant_hsm_instance_proposal_id string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

↳ single_tenant_hsm_instance_proposal SingleTenantHsmInstanceProposal

Required. The SingleTenantHsmInstanceProposal to create.

getParent

Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals.

Returns
Type Description
string

setParent

Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals.

Parameter
Name Description
var string
Returns
Type Description
$this

getSingleTenantHsmInstanceProposalId

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

Returns
Type Description
string

setSingleTenantHsmInstanceProposalId

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

Parameter
Name Description
var string
Returns
Type Description
$this

getSingleTenantHsmInstanceProposal

Required. The SingleTenantHsmInstanceProposal to create.

Returns
Type Description
SingleTenantHsmInstanceProposal|null

hasSingleTenantHsmInstanceProposal

clearSingleTenantHsmInstanceProposal

setSingleTenantHsmInstanceProposal

Required. The SingleTenantHsmInstanceProposal to create.

Parameter
Name Description
var SingleTenantHsmInstanceProposal
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals. Please see HsmManagementClient::singleTenantHsmInstanceName() for help formatting this field.

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The SingleTenantHsmInstanceProposal to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

Returns
Type Description
CreateSingleTenantHsmInstanceProposalRequest