Reference documentation and code samples for the Cloud KMS V1 Client class SingleTenantHsmInstance.
A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT, as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.
Generated from protobuf message google.cloud.kms.v1.SingleTenantHsmInstance
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name for this SingleTenantHsmInstance in the format |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the SingleTenantHsmInstance was created. |
↳ state |
int
Output only. The state of the SingleTenantHsmInstance. |
↳ quorum_auth |
SingleTenantHsmInstance\QuorumAuth
Required. The quorum auth configuration for the SingleTenantHsmInstance. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. The time at which the SingleTenantHsmInstance was deleted. |
↳ unrefreshed_duration_until_disable |
Google\Protobuf\Duration
Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 120 days. |
↳ disable_time |
Google\Protobuf\Timestamp
Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled. |
getName
Identifier. The resource name for this
SingleTenantHsmInstance in
the format projects/*/locations/*/singleTenantHsmInstances/*.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name for this
SingleTenantHsmInstance in
the format projects/*/locations/*/singleTenantHsmInstances/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which the SingleTenantHsmInstance was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the SingleTenantHsmInstance was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the SingleTenantHsmInstance.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The state of the SingleTenantHsmInstance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuorumAuth
Required. The quorum auth configuration for the SingleTenantHsmInstance.
| Returns | |
|---|---|
| Type | Description |
SingleTenantHsmInstance\QuorumAuth|null |
|
hasQuorumAuth
clearQuorumAuth
setQuorumAuth
Required. The quorum auth configuration for the SingleTenantHsmInstance.
| Parameter | |
|---|---|
| Name | Description |
var |
SingleTenantHsmInstance\QuorumAuth
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteTime
Output only. The time at which the SingleTenantHsmInstance was deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The time at which the SingleTenantHsmInstance was deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnrefreshedDurationUntilDisable
Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 120 days.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasUnrefreshedDurationUntilDisable
clearUnrefreshedDurationUntilDisable
setUnrefreshedDurationUntilDisable
Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 120 days.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableTime
Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasDisableTime
clearDisableTime
setDisableTime
Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|