Cloud KMS V1 Client - Class CreateSingleTenantHsmInstanceRequest (2.6.0)

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

Request message for HsmManagement.CreateSingleTenantHsmInstance.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the location associated with the SingleTenantHsmInstance, in the format projects/*/locations/*.

↳ single_tenant_hsm_instance_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 SingleTenantHsmInstance

Required. An SingleTenantHsmInstance with initial field values.

getParent

Required. The resource name of the location associated with the SingleTenantHsmInstance, in the format projects/*/locations/*.

Returns
Type Description
string

setParent

Required. The resource name of the location associated with the SingleTenantHsmInstance, in the format projects/*/locations/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getSingleTenantHsmInstanceId

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

Returns
Type Description
string

setSingleTenantHsmInstanceId

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

getSingleTenantHsmInstance

Required. An SingleTenantHsmInstance with initial field values.

Returns
Type Description
SingleTenantHsmInstance|null

hasSingleTenantHsmInstance

clearSingleTenantHsmInstance

setSingleTenantHsmInstance

Required. An SingleTenantHsmInstance with initial field values.

Parameter
Name Description
var SingleTenantHsmInstance
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The resource name of the location associated with the SingleTenantHsmInstance, in the format projects/*/locations/*. Please see HsmManagementClient::locationName() for help formatting this field.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An SingleTenantHsmInstance with initial field values.

singleTenantHsmInstanceId string

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

Returns
Type Description
CreateSingleTenantHsmInstanceRequest