Class SingleTenantHsmInstanceProposal (2.86.0)

public final class SingleTenantHsmInstanceProposal extends GeneratedMessage implements SingleTenantHsmInstanceProposalOrBuilder

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

Protobuf type google.cloud.kms.v1.SingleTenantHsmInstanceProposal

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SingleTenantHsmInstanceProposal

Static Fields

ADD_QUORUM_MEMBER_FIELD_NUMBER

public static final int ADD_QUORUM_MEMBER_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETE_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER

public static final int DELETE_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER

public static final int DISABLE_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER

public static final int ENABLE_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_REASON_FIELD_NUMBER

public static final int FAILURE_REASON_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PURGE_TIME_FIELD_NUMBER

public static final int PURGE_TIME_FIELD_NUMBER
Field Value
Type Description
int

QUORUM_PARAMETERS_FIELD_NUMBER

public static final int QUORUM_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

REFRESH_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER

public static final int REFRESH_SINGLE_TENANT_HSM_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

REGISTER_TWO_FACTOR_AUTH_KEYS_FIELD_NUMBER

public static final int REGISTER_TWO_FACTOR_AUTH_KEYS_FIELD_NUMBER
Field Value
Type Description
int

REMOVE_QUORUM_MEMBER_FIELD_NUMBER

public static final int REMOVE_QUORUM_MEMBER_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_ACTION_QUORUM_PARAMETERS_FIELD_NUMBER

public static final int REQUIRED_ACTION_QUORUM_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SingleTenantHsmInstanceProposal getDefaultInstance()
Returns
Type Description
SingleTenantHsmInstanceProposal

getDescriptor()

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

newBuilder()

public static SingleTenantHsmInstanceProposal.Builder newBuilder()
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

newBuilder(SingleTenantHsmInstanceProposal prototype)

public static SingleTenantHsmInstanceProposal.Builder newBuilder(SingleTenantHsmInstanceProposal prototype)
Parameter
Name Description
prototype SingleTenantHsmInstanceProposal
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder

parseDelimitedFrom(InputStream input)

public static SingleTenantHsmInstanceProposal parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstanceProposal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SingleTenantHsmInstanceProposal parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstanceProposal parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SingleTenantHsmInstanceProposal parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstanceProposal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SingleTenantHsmInstanceProposal parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstanceProposal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SingleTenantHsmInstanceProposal parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstanceProposal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SingleTenantHsmInstanceProposal parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SingleTenantHsmInstanceProposal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SingleTenantHsmInstanceProposal
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SingleTenantHsmInstanceProposal> parser()
Returns
Type Description
Parser<SingleTenantHsmInstanceProposal>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

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.

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.

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

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.

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.

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.

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

getParserForType()

public Parser<SingleTenantHsmInstanceProposal> getParserForType()
Returns
Type Description
Parser<SingleTenantHsmInstanceProposal>
Overrides

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.

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.

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.

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.

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SingleTenantHsmInstanceProposal.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SingleTenantHsmInstanceProposal.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException