Class SingleTenantHsmInstanceProposal.Builder (2.86.0) 

public static final class SingleTenantHsmInstanceProposal.Builder extends GeneratedMessage.Builder<SingleTenantHsmInstanceProposal.Builder> implements SingleTenantHsmInstanceProposalOrBuilder

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

Protobuf type google.cloud.kms.v1.SingleTenantHsmInstanceProposal

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SingleTenantHsmInstanceProposal.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SingleTenantHsmInstanceProposal build()
Returns
Type Description
SingleTenantHsmInstanceProposal

buildPartial()

public SingleTenantHsmInstanceProposal buildPartial()
Returns
Type Description
SingleTenantHsmInstanceProposal

clear()

public SingleTenantHsmInstanceProposal.Builder clear()
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder
Overrides

clearAddQuorumMember()

public SingleTenantHsmInstanceProposal.Builder clearAddQuorumMember()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearApprovalParameters()

public SingleTenantHsmInstanceProposal.Builder clearApprovalParameters()
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearCreateTime()

public SingleTenantHsmInstanceProposal.Builder clearCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearDeleteSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.Builder clearDeleteSingleTenantHsmInstance()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearDeleteTime()

public SingleTenantHsmInstanceProposal.Builder clearDeleteTime()

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearDisableSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.Builder clearDisableSingleTenantHsmInstance()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearEnableSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.Builder clearEnableSingleTenantHsmInstance()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearExpiration()

public SingleTenantHsmInstanceProposal.Builder clearExpiration()
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearExpireTime()

public SingleTenantHsmInstanceProposal.Builder clearExpireTime()

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

.google.protobuf.Timestamp expire_time = 6;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearFailureReason()

public SingleTenantHsmInstanceProposal.Builder clearFailureReason()

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

string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

clearName()

public SingleTenantHsmInstanceProposal.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

clearOperation()

public SingleTenantHsmInstanceProposal.Builder clearOperation()
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearPurgeTime()

public SingleTenantHsmInstanceProposal.Builder clearPurgeTime()

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearQuorumParameters()

public SingleTenantHsmInstanceProposal.Builder clearQuorumParameters()

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearRefreshSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.Builder clearRefreshSingleTenantHsmInstance()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearRegisterTwoFactorAuthKeys()

public SingleTenantHsmInstanceProposal.Builder clearRegisterTwoFactorAuthKeys()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearRemoveQuorumMember()

public SingleTenantHsmInstanceProposal.Builder clearRemoveQuorumMember()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearRequiredActionQuorumParameters()

public SingleTenantHsmInstanceProposal.Builder clearRequiredActionQuorumParameters()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

clearState()

public SingleTenantHsmInstanceProposal.Builder clearState()

Output only. The state of the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

clearTtl()

public SingleTenantHsmInstanceProposal.Builder clearTtl()

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

getAddQuorumMember()

public SingleTenantHsmInstanceProposal.AddQuorumMember 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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Returns
Type Description
SingleTenantHsmInstanceProposal.AddQuorumMember

The addQuorumMember.

getAddQuorumMemberBuilder()

public SingleTenantHsmInstanceProposal.AddQuorumMember.Builder getAddQuorumMemberBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Returns
Type Description
SingleTenantHsmInstanceProposal.AddQuorumMember.Builder

getAddQuorumMemberOrBuilder()

public SingleTenantHsmInstanceProposal.AddQuorumMemberOrBuilder getAddQuorumMemberOrBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Returns
Type Description
SingleTenantHsmInstanceProposal.AddQuorumMemberOrBuilder

getApprovalParametersCase()

public SingleTenantHsmInstanceProposal.ApprovalParametersCase getApprovalParametersCase()
Returns
Type Description
SingleTenantHsmInstanceProposal.ApprovalParametersCase

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public SingleTenantHsmInstanceProposal getDefaultInstanceForType()
Returns
Type Description
SingleTenantHsmInstanceProposal

getDeleteSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance 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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Returns
Type Description
SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance

The deleteSingleTenantHsmInstance.

getDeleteSingleTenantHsmInstanceBuilder()

public SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance.Builder getDeleteSingleTenantHsmInstanceBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Returns
Type Description
SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance.Builder

getDeleteSingleTenantHsmInstanceOrBuilder()

public SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstanceOrBuilder getDeleteSingleTenantHsmInstanceOrBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Returns
Type Description
SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstanceOrBuilder

getDeleteTime()

public Timestamp getDeleteTime()

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance getDisableSingleTenantHsmInstance()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Returns
Type Description
SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance

The disableSingleTenantHsmInstance.

getDisableSingleTenantHsmInstanceBuilder()

public SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance.Builder getDisableSingleTenantHsmInstanceBuilder()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Returns
Type Description
SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance.Builder

getDisableSingleTenantHsmInstanceOrBuilder()

public SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstanceOrBuilder getDisableSingleTenantHsmInstanceOrBuilder()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Returns
Type Description
SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstanceOrBuilder

getEnableSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance getEnableSingleTenantHsmInstance()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Returns
Type Description
SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance

The enableSingleTenantHsmInstance.

getEnableSingleTenantHsmInstanceBuilder()

public SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance.Builder getEnableSingleTenantHsmInstanceBuilder()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Returns
Type Description
SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance.Builder

getEnableSingleTenantHsmInstanceOrBuilder()

public SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstanceOrBuilder getEnableSingleTenantHsmInstanceOrBuilder()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Returns
Type Description
SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstanceOrBuilder

getExpirationCase()

public SingleTenantHsmInstanceProposal.ExpirationCase getExpirationCase()
Returns
Type Description
SingleTenantHsmInstanceProposal.ExpirationCase

getExpireTime()

public Timestamp getExpireTime()

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

.google.protobuf.Timestamp expire_time = 6;

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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

.google.protobuf.Timestamp expire_time = 6;

Returns
Type Description
Builder

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

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

.google.protobuf.Timestamp expire_time = 6;

Returns
Type Description
TimestampOrBuilder

getFailureReason()

public String getFailureReason()

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

string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The failureReason.

getFailureReasonBytes()

public ByteString getFailureReasonBytes()

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

string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for failureReason.

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOperationCase()

public SingleTenantHsmInstanceProposal.OperationCase getOperationCase()
Returns
Type Description
SingleTenantHsmInstanceProposal.OperationCase

getPurgeTime()

public Timestamp 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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The purgeTime.

getPurgeTimeBuilder()

public Timestamp.Builder getPurgeTimeBuilder()

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getPurgeTimeOrBuilder()

public TimestampOrBuilder getPurgeTimeOrBuilder()

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getQuorumParameters()

public SingleTenantHsmInstanceProposal.QuorumParameters getQuorumParameters()

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.QuorumParameters

The quorumParameters.

getQuorumParametersBuilder()

public SingleTenantHsmInstanceProposal.QuorumParameters.Builder getQuorumParametersBuilder()

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.QuorumParameters.Builder

getQuorumParametersOrBuilder()

public SingleTenantHsmInstanceProposal.QuorumParametersOrBuilder getQuorumParametersOrBuilder()

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.QuorumParametersOrBuilder

getRefreshSingleTenantHsmInstance()

public SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance 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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Returns
Type Description
SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance

The refreshSingleTenantHsmInstance.

getRefreshSingleTenantHsmInstanceBuilder()

public SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance.Builder getRefreshSingleTenantHsmInstanceBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Returns
Type Description
SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance.Builder

getRefreshSingleTenantHsmInstanceOrBuilder()

public SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstanceOrBuilder getRefreshSingleTenantHsmInstanceOrBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Returns
Type Description
SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstanceOrBuilder

getRegisterTwoFactorAuthKeys()

public SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys 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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Returns
Type Description
SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys

The registerTwoFactorAuthKeys.

getRegisterTwoFactorAuthKeysBuilder()

public SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys.Builder getRegisterTwoFactorAuthKeysBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Returns
Type Description
SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys.Builder

getRegisterTwoFactorAuthKeysOrBuilder()

public SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeysOrBuilder getRegisterTwoFactorAuthKeysOrBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Returns
Type Description
SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeysOrBuilder

getRemoveQuorumMember()

public SingleTenantHsmInstanceProposal.RemoveQuorumMember 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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Returns
Type Description
SingleTenantHsmInstanceProposal.RemoveQuorumMember

The removeQuorumMember.

getRemoveQuorumMemberBuilder()

public SingleTenantHsmInstanceProposal.RemoveQuorumMember.Builder getRemoveQuorumMemberBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Returns
Type Description
SingleTenantHsmInstanceProposal.RemoveQuorumMember.Builder

getRemoveQuorumMemberOrBuilder()

public SingleTenantHsmInstanceProposal.RemoveQuorumMemberOrBuilder getRemoveQuorumMemberOrBuilder()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Returns
Type Description
SingleTenantHsmInstanceProposal.RemoveQuorumMemberOrBuilder

getRequiredActionQuorumParameters()

public SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters getRequiredActionQuorumParameters()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters

The requiredActionQuorumParameters.

getRequiredActionQuorumParametersBuilder()

public SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters.Builder getRequiredActionQuorumParametersBuilder()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters.Builder

getRequiredActionQuorumParametersOrBuilder()

public SingleTenantHsmInstanceProposal.RequiredActionQuorumParametersOrBuilder getRequiredActionQuorumParametersOrBuilder()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.RequiredActionQuorumParametersOrBuilder

getState()

public SingleTenantHsmInstanceProposal.State getState()

Output only. The state of the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SingleTenantHsmInstanceProposal.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTtl()

public Duration getTtl()

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Duration

The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
DurationOrBuilder

hasAddQuorumMember()

public boolean hasAddQuorumMember()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Returns
Type Description
boolean

Whether the addQuorumMember field is set.

hasCreateTime()

public boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteSingleTenantHsmInstance()

public boolean hasDeleteSingleTenantHsmInstance()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Returns
Type Description
boolean

Whether the deleteSingleTenantHsmInstance field is set.

hasDeleteTime()

public boolean hasDeleteTime()

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasDisableSingleTenantHsmInstance()

public boolean hasDisableSingleTenantHsmInstance()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Returns
Type Description
boolean

Whether the disableSingleTenantHsmInstance field is set.

hasEnableSingleTenantHsmInstance()

public boolean hasEnableSingleTenantHsmInstance()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Returns
Type Description
boolean

Whether the enableSingleTenantHsmInstance field is set.

hasExpireTime()

public boolean hasExpireTime()

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

.google.protobuf.Timestamp expire_time = 6;

Returns
Type Description
boolean

Whether the expireTime field is set.

hasPurgeTime()

public boolean hasPurgeTime()

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the purgeTime field is set.

hasQuorumParameters()

public boolean hasQuorumParameters()

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the quorumParameters field is set.

hasRefreshSingleTenantHsmInstance()

public boolean hasRefreshSingleTenantHsmInstance()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Returns
Type Description
boolean

Whether the refreshSingleTenantHsmInstance field is set.

hasRegisterTwoFactorAuthKeys()

public boolean hasRegisterTwoFactorAuthKeys()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Returns
Type Description
boolean

Whether the registerTwoFactorAuthKeys field is set.

hasRemoveQuorumMember()

public boolean hasRemoveQuorumMember()

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Returns
Type Description
boolean

Whether the removeQuorumMember field is set.

hasRequiredActionQuorumParameters()

public boolean hasRequiredActionQuorumParameters()

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the requiredActionQuorumParameters field is set.

hasTtl()

public boolean hasTtl()

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the ttl field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAddQuorumMember(SingleTenantHsmInstanceProposal.AddQuorumMember value)

public SingleTenantHsmInstanceProposal.Builder mergeAddQuorumMember(SingleTenantHsmInstanceProposal.AddQuorumMember value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.AddQuorumMember
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeCreateTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder mergeCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeDeleteSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder mergeDeleteSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeDeleteTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder mergeDeleteTime(Timestamp value)

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeDisableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder mergeDisableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance value)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeEnableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder mergeEnableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance value)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeExpireTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder mergeExpireTime(Timestamp value)

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

.google.protobuf.Timestamp expire_time = 6;

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeFrom(SingleTenantHsmInstanceProposal other)

public SingleTenantHsmInstanceProposal.Builder mergeFrom(SingleTenantHsmInstanceProposal other)
Parameter
Name Description
other SingleTenantHsmInstanceProposal
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SingleTenantHsmInstanceProposal.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SingleTenantHsmInstanceProposal.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder
Overrides

mergePurgeTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder mergePurgeTime(Timestamp value)

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeQuorumParameters(SingleTenantHsmInstanceProposal.QuorumParameters value)

public SingleTenantHsmInstanceProposal.Builder mergeQuorumParameters(SingleTenantHsmInstanceProposal.QuorumParameters value)

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SingleTenantHsmInstanceProposal.QuorumParameters
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeRefreshSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder mergeRefreshSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeRegisterTwoFactorAuthKeys(SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys value)

public SingleTenantHsmInstanceProposal.Builder mergeRegisterTwoFactorAuthKeys(SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeRemoveQuorumMember(SingleTenantHsmInstanceProposal.RemoveQuorumMember value)

public SingleTenantHsmInstanceProposal.Builder mergeRemoveQuorumMember(SingleTenantHsmInstanceProposal.RemoveQuorumMember value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RemoveQuorumMember
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeRequiredActionQuorumParameters(SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters value)

public SingleTenantHsmInstanceProposal.Builder mergeRequiredActionQuorumParameters(SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters value)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

mergeTtl(Duration value)

public SingleTenantHsmInstanceProposal.Builder mergeTtl(Duration value)

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value Duration
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setAddQuorumMember(SingleTenantHsmInstanceProposal.AddQuorumMember value)

public SingleTenantHsmInstanceProposal.Builder setAddQuorumMember(SingleTenantHsmInstanceProposal.AddQuorumMember value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.AddQuorumMember
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setAddQuorumMember(SingleTenantHsmInstanceProposal.AddQuorumMember.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setAddQuorumMember(SingleTenantHsmInstanceProposal.AddQuorumMember.Builder builderForValue)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.AddQuorumMember.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setCreateTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder setCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setCreateTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setCreateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setDeleteSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder setDeleteSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setDeleteSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setDeleteSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance.Builder builderForValue)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setDeleteTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder setDeleteTime(Timestamp value)

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setDeleteTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setDisableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder setDisableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance value)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setDisableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setDisableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance.Builder builderForValue)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setEnableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder setEnableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance value)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setEnableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setEnableSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance.Builder builderForValue)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setExpireTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder setExpireTime(Timestamp value)

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

.google.protobuf.Timestamp expire_time = 6;

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setExpireTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setExpireTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp expire_time = 6;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setFailureReason(String value)

public SingleTenantHsmInstanceProposal.Builder setFailureReason(String value)

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

string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The failureReason to set.
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

setFailureReasonBytes(ByteString value)

public SingleTenantHsmInstanceProposal.Builder setFailureReasonBytes(ByteString value)

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

string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for failureReason to set.
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

setName(String value)

public SingleTenantHsmInstanceProposal.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SingleTenantHsmInstanceProposal.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

setPurgeTime(Timestamp value)

public SingleTenantHsmInstanceProposal.Builder setPurgeTime(Timestamp value)

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setPurgeTime(Timestamp.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setPurgeTime(Timestamp.Builder builderForValue)

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).

.google.protobuf.Timestamp purge_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setQuorumParameters(SingleTenantHsmInstanceProposal.QuorumParameters value)

public SingleTenantHsmInstanceProposal.Builder setQuorumParameters(SingleTenantHsmInstanceProposal.QuorumParameters value)

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SingleTenantHsmInstanceProposal.QuorumParameters
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setQuorumParameters(SingleTenantHsmInstanceProposal.QuorumParameters.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setQuorumParameters(SingleTenantHsmInstanceProposal.QuorumParameters.Builder builderForValue)

Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.QuorumParameters.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRefreshSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance value)

public SingleTenantHsmInstanceProposal.Builder setRefreshSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRefreshSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setRefreshSingleTenantHsmInstance(SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance.Builder builderForValue)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRegisterTwoFactorAuthKeys(SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys value)

public SingleTenantHsmInstanceProposal.Builder setRegisterTwoFactorAuthKeys(SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRegisterTwoFactorAuthKeys(SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setRegisterTwoFactorAuthKeys(SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys.Builder builderForValue)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRemoveQuorumMember(SingleTenantHsmInstanceProposal.RemoveQuorumMember value)

public SingleTenantHsmInstanceProposal.Builder setRemoveQuorumMember(SingleTenantHsmInstanceProposal.RemoveQuorumMember value)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RemoveQuorumMember
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRemoveQuorumMember(SingleTenantHsmInstanceProposal.RemoveQuorumMember.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setRemoveQuorumMember(SingleTenantHsmInstanceProposal.RemoveQuorumMember.Builder builderForValue)

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.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.RemoveQuorumMember.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRequiredActionQuorumParameters(SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters value)

public SingleTenantHsmInstanceProposal.Builder setRequiredActionQuorumParameters(SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters value)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setRequiredActionQuorumParameters(SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setRequiredActionQuorumParameters(SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters.Builder builderForValue)

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

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters required_action_quorum_parameters = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters.Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setState(SingleTenantHsmInstanceProposal.State value)

public SingleTenantHsmInstanceProposal.Builder setState(SingleTenantHsmInstanceProposal.State value)

Output only. The state of the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SingleTenantHsmInstanceProposal.State

The state to set.
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

setStateValue(int value)

public SingleTenantHsmInstanceProposal.Builder setStateValue(int value)

Output only. The state of the SingleTenantHsmInstanceProposal.

.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

This builder for chaining.

setTtl(Duration value)

public SingleTenantHsmInstanceProposal.Builder setTtl(Duration value)

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value Duration
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

setTtl(Duration.Builder builderForValue)

public SingleTenantHsmInstanceProposal.Builder setTtl(Duration.Builder builderForValue)

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder