Interface SingleTenantHsmInstanceProposalOrBuilder (2.86.0)

public interface SingleTenantHsmInstanceProposalOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAddQuorumMember()

public abstract 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.

getAddQuorumMemberOrBuilder()

public abstract 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 abstract SingleTenantHsmInstanceProposal.ApprovalParametersCase getApprovalParametersCase()
Returns
Type Description
SingleTenantHsmInstanceProposal.ApprovalParametersCase

getCreateTime()

public abstract 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.

getCreateTimeOrBuilder()

public abstract 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

getDeleteSingleTenantHsmInstance()

public abstract 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.

getDeleteSingleTenantHsmInstanceOrBuilder()

public abstract 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 abstract 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.

getDeleteTimeOrBuilder()

public abstract 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

getDisableSingleTenantHsmInstance()

public abstract 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.

getDisableSingleTenantHsmInstanceOrBuilder()

public abstract 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 abstract 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.

getEnableSingleTenantHsmInstanceOrBuilder()

public abstract 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 abstract SingleTenantHsmInstanceProposal.ExpirationCase getExpirationCase()
Returns
Type Description
SingleTenantHsmInstanceProposal.ExpirationCase

getExpireTime()

public abstract 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.

getExpireTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract SingleTenantHsmInstanceProposal.OperationCase getOperationCase()
Returns
Type Description
SingleTenantHsmInstanceProposal.OperationCase

getPurgeTime()

public abstract 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.

getPurgeTimeOrBuilder()

public abstract 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 abstract 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.

getQuorumParametersOrBuilder()

public abstract 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 abstract 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.

getRefreshSingleTenantHsmInstanceOrBuilder()

public abstract 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 abstract 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.

getRegisterTwoFactorAuthKeysOrBuilder()

public abstract 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 abstract 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.

getRemoveQuorumMemberOrBuilder()

public abstract 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 abstract 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.

getRequiredActionQuorumParametersOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

getTtlOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.