Cloud KMS V1 Client - Class SingleTenantHsmInstanceProposal (2.6.0)

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

A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__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 projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.
↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the SingleTenantHsmInstanceProposal was created.
↳ state int

Output only. The state of the SingleTenantHsmInstanceProposal.
↳ failure_reason string

Output only. The root cause of the most recent failure. Only present if state is FAILED.
↳ quorum_parameters SingleTenantHsmInstanceProposal\QuorumParameters

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.
↳ required_action_quorum_parameters SingleTenantHsmInstanceProposal\RequiredActionQuorumParameters

Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.
↳ expire_time Google\Protobuf\Timestamp

The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
↳ ttl Google\Protobuf\Duration

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.
↳ delete_time Google\Protobuf\Timestamp

Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
↳ purge_time Google\Protobuf\Timestamp

Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).
↳ register_two_factor_auth_keys SingleTenantHsmInstanceProposal\RegisterTwoFactorAuthKeys

Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
↳ disable_single_tenant_hsm_instance SingleTenantHsmInstanceProposal\DisableSingleTenantHsmInstance

Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
↳ enable_single_tenant_hsm_instance SingleTenantHsmInstanceProposal\EnableSingleTenantHsmInstance

Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.
↳ delete_single_tenant_hsm_instance SingleTenantHsmInstanceProposal\DeleteSingleTenantHsmInstance

Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
↳ add_quorum_member SingleTenantHsmInstanceProposal\AddQuorumMember

Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
↳ remove_quorum_member SingleTenantHsmInstanceProposal\RemoveQuorumMember

Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
↳ refresh_single_tenant_hsm_instance SingleTenantHsmInstanceProposal\RefreshSingleTenantHsmInstance

Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

getName

Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

Returns
Type Description
string

setName

Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time at which the SingleTenantHsmInstanceProposal was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the SingleTenantHsmInstanceProposal was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. The state of the SingleTenantHsmInstanceProposal.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the SingleTenantHsmInstanceProposal.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getFailureReason

Output only. The root cause of the most recent failure. Only present if state is FAILED.

Returns
Type Description
string

setFailureReason

Output only. The root cause of the most recent failure. Only present if state is FAILED.

Parameter
Name Description
var string
Returns
Type Description
$this

getQuorumParameters

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

Returns
Type Description
SingleTenantHsmInstanceProposal\QuorumParameters|null

hasQuorumParameters

setQuorumParameters

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\QuorumParameters
Returns
Type Description
$this

getRequiredActionQuorumParameters

Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.

Returns
Type Description
SingleTenantHsmInstanceProposal\RequiredActionQuorumParameters|null

hasRequiredActionQuorumParameters

setRequiredActionQuorumParameters

Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\RequiredActionQuorumParameters
Returns
Type Description
$this

getExpireTime

The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasExpireTime

setExpireTime

The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getTtl

Input only. The TTL for the SingleTenantHsmInstanceProposal.

Proposals will expire after this duration.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

setTtl

Input only. The TTL for the SingleTenantHsmInstanceProposal.

Proposals will expire after this duration.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getDeleteTime

Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPurgeTime

Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasPurgeTime

clearPurgeTime

setPurgeTime

Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRegisterTwoFactorAuthKeys

Register 2FA keys for the SingleTenantHsmInstance.

This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\RegisterTwoFactorAuthKeys|null

hasRegisterTwoFactorAuthKeys

setRegisterTwoFactorAuthKeys

Register 2FA keys for the SingleTenantHsmInstance.

This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\RegisterTwoFactorAuthKeys
Returns
Type Description
$this

getDisableSingleTenantHsmInstance

Disable the SingleTenantHsmInstance.

The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\DisableSingleTenantHsmInstance|null

hasDisableSingleTenantHsmInstance

setDisableSingleTenantHsmInstance

Disable the SingleTenantHsmInstance.

The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\DisableSingleTenantHsmInstance
Returns
Type Description
$this

getEnableSingleTenantHsmInstance

Enable the SingleTenantHsmInstance.

The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\EnableSingleTenantHsmInstance|null

hasEnableSingleTenantHsmInstance

setEnableSingleTenantHsmInstance

Enable the SingleTenantHsmInstance.

The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\EnableSingleTenantHsmInstance
Returns
Type Description
$this

getDeleteSingleTenantHsmInstance

Delete the SingleTenantHsmInstance.

Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\DeleteSingleTenantHsmInstance|null

hasDeleteSingleTenantHsmInstance

setDeleteSingleTenantHsmInstance

Delete the SingleTenantHsmInstance.

Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\DeleteSingleTenantHsmInstance
Returns
Type Description
$this

getAddQuorumMember

Add a quorum member to the SingleTenantHsmInstance.

This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\AddQuorumMember|null

hasAddQuorumMember

setAddQuorumMember

Add a quorum member to the SingleTenantHsmInstance.

This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\AddQuorumMember
Returns
Type Description
$this

getRemoveQuorumMember

Remove a quorum member from the SingleTenantHsmInstance.

This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\RemoveQuorumMember|null

hasRemoveQuorumMember

setRemoveQuorumMember

Remove a quorum member from the SingleTenantHsmInstance.

This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\RemoveQuorumMember
Returns
Type Description
$this

getRefreshSingleTenantHsmInstance

Refreshes the SingleTenantHsmInstance.

This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Returns
Type Description
SingleTenantHsmInstanceProposal\RefreshSingleTenantHsmInstance|null

hasRefreshSingleTenantHsmInstance

setRefreshSingleTenantHsmInstance

Refreshes the SingleTenantHsmInstance.

This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Parameter
Name Description
var SingleTenantHsmInstanceProposal\RefreshSingleTenantHsmInstance
Returns
Type Description
$this

getApprovalParameters

Returns
Type Description
string

getExpiration

Returns
Type Description
string

getOperation

Returns
Type Description
string