Package com.google.cloud.kms.v1
Interface SingleTenantHsmInstanceProposalOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
SingleTenantHsmInstanceProposal,SingleTenantHsmInstanceProposal.Builder
@Generated
public interface SingleTenantHsmInstanceProposalOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionAdd a quorum member to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Add a quorum member to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Delete the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Delete the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Disable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Disable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Enable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Enable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].com.google.protobuf.TimestampThe time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] will expire if not approved and executed.com.google.protobuf.TimestampOrBuilderThe time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] will expire if not approved and executed.Output only.com.google.protobuf.ByteStringOutput only.getName()Identifier.com.google.protobuf.ByteStringIdentifier.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.Output only.Refreshes the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Refreshes the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Register 2FA keys for the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Register 2FA keys for the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Remove a quorum member from the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Remove a quorum member from the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].Output only.Output only.getState()Output only.intOutput only.com.google.protobuf.DurationgetTtl()Input only.com.google.protobuf.DurationOrBuilderInput only.Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key.Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key.booleanAdd a quorum member to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanOutput only.booleanDelete the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanOutput only.booleanDisable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanEnable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanThe time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] will expire if not approved and executed.booleanOutput only.booleanOutput only.booleanRefreshes the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanRegister 2FA keys for the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanRemove a quorum member from the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].booleanOutput only.booleanhasTtl()Input only.booleanPromotes a key with the AES_WRAPPING purpose to a trusted wrapping key.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Identifier. The resource name for this [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] in the format `projects/*/locations/*/singleTenantHsmInstances/*/proposals/*`.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Identifier. The resource name for this [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] in the format `projects/*/locations/*/singleTenantHsmInstances/*/proposals/*`.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The bytes for name.
-
hasCreateTime
boolean hasCreateTime()Output only. The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getStateValue
int getStateValue()Output only. The state of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for state.
-
getState
SingleTenantHsmInstanceProposal.State getState()Output only. The state of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The state.
-
getFailureReason
String getFailureReason()Output only. The root cause of the most recent failure. Only present if [state][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.state] is [FAILED][SingleTenantHsmInstanceProposal.FAILED].
string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The failureReason.
-
getFailureReasonBytes
com.google.protobuf.ByteString getFailureReasonBytes()Output only. The root cause of the most recent failure. Only present if [state][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.state] is [FAILED][SingleTenantHsmInstanceProposal.FAILED].
string failure_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for failureReason.
-
hasQuorumParameters
boolean hasQuorumParameters()Output only. The quorum approval parameters for the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the quorumParameters field is set.
-
getQuorumParameters
SingleTenantHsmInstanceProposal.QuorumParameters getQuorumParameters()Output only. The quorum approval parameters for the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The quorumParameters.
-
getQuorumParametersOrBuilder
SingleTenantHsmInstanceProposal.QuorumParametersOrBuilder getQuorumParametersOrBuilder()Output only. The quorum approval parameters for the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters quorum_parameters = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasRequiredActionQuorumParameters
boolean hasRequiredActionQuorumParameters()Output only. Parameters for an approval of a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.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:
- Whether the requiredActionQuorumParameters field is set.
-
getRequiredActionQuorumParameters
SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters getRequiredActionQuorumParameters()Output only. Parameters for an approval of a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.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:
- The requiredActionQuorumParameters.
-
getRequiredActionQuorumParametersOrBuilder
SingleTenantHsmInstanceProposal.RequiredActionQuorumParametersOrBuilder getRequiredActionQuorumParametersOrBuilder()Output only. Parameters for an approval of a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.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]; -
hasExpireTime
boolean hasExpireTime()The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] will expire if not approved and executed.
.google.protobuf.Timestamp expire_time = 6;- Returns:
- Whether the expireTime field is set.
-
getExpireTime
com.google.protobuf.Timestamp getExpireTime()The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] will expire if not approved and executed.
.google.protobuf.Timestamp expire_time = 6;- Returns:
- The expireTime.
-
getExpireTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] will expire if not approved and executed.
.google.protobuf.Timestamp expire_time = 6; -
hasTtl
boolean hasTtl()Input only. The TTL for the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]. Proposals will expire after this duration.
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];- Returns:
- Whether the ttl field is set.
-
getTtl
com.google.protobuf.Duration getTtl()Input only. The TTL for the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]. Proposals will expire after this duration.
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];- Returns:
- The ttl.
-
getTtlOrBuilder
com.google.protobuf.DurationOrBuilder getTtlOrBuilder()Input only. The TTL for the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]. Proposals will expire after this duration.
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY]; -
hasDeleteTime
boolean hasDeleteTime()Output only. The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] was deleted.
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
com.google.protobuf.Timestamp getDeleteTime()Output only. The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] was deleted.
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()Output only. The time at which the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] was deleted.
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasPurgeTime
boolean hasPurgeTime()Output only. The time at which the soft-deleted [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.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:
- Whether the purgeTime field is set.
-
getPurgeTime
com.google.protobuf.Timestamp getPurgeTime()Output only. The time at which the soft-deleted [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.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:
- The purgeTime.
-
getPurgeTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getPurgeTimeOrBuilder()Output only. The time at which the soft-deleted [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.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]; -
hasRegisterTwoFactorAuthKeys
boolean hasRegisterTwoFactorAuthKeys()Register 2FA keys for the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This operation requires all N Challenges to be signed by 2FA keys. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [PENDING_TWO_FACTOR_AUTH_REGISTRATION][google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;- Returns:
- Whether the registerTwoFactorAuthKeys field is set.
-
getRegisterTwoFactorAuthKeys
SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys getRegisterTwoFactorAuthKeys()Register 2FA keys for the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This operation requires all N Challenges to be signed by 2FA keys. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [PENDING_TWO_FACTOR_AUTH_REGISTRATION][google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8;- Returns:
- The registerTwoFactorAuthKeys.
-
getRegisterTwoFactorAuthKeysOrBuilder
SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeysOrBuilder getRegisterTwoFactorAuthKeysOrBuilder()Register 2FA keys for the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This operation requires all N Challenges to be signed by 2FA keys. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [PENDING_TWO_FACTOR_AUTH_REGISTRATION][google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RegisterTwoFactorAuthKeys register_two_factor_auth_keys = 8; -
hasDisableSingleTenantHsmInstance
boolean hasDisableSingleTenantHsmInstance()Disable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;- Returns:
- Whether the disableSingleTenantHsmInstance field is set.
-
getDisableSingleTenantHsmInstance
SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance getDisableSingleTenantHsmInstance()Disable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9;- Returns:
- The disableSingleTenantHsmInstance.
-
getDisableSingleTenantHsmInstanceOrBuilder
SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstanceOrBuilder getDisableSingleTenantHsmInstanceOrBuilder()Disable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance disable_single_tenant_hsm_instance = 9; -
hasEnableSingleTenantHsmInstance
boolean hasEnableSingleTenantHsmInstance()Enable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [DISABLED][google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;- Returns:
- Whether the enableSingleTenantHsmInstance field is set.
-
getEnableSingleTenantHsmInstance
SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance getEnableSingleTenantHsmInstance()Enable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [DISABLED][google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10;- Returns:
- The enableSingleTenantHsmInstance.
-
getEnableSingleTenantHsmInstanceOrBuilder
SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstanceOrBuilder getEnableSingleTenantHsmInstanceOrBuilder()Enable the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [DISABLED][google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance enable_single_tenant_hsm_instance = 10; -
hasDeleteSingleTenantHsmInstance
boolean hasDeleteSingleTenantHsmInstance()Delete the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. Deleting a [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] will make all [CryptoKeys][google.cloud.kms.v1.CryptoKey] attached to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] unusable. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [DISABLED][google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED] or [PENDING_TWO_FACTOR_AUTH_REGISTRATION][google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;- Returns:
- Whether the deleteSingleTenantHsmInstance field is set.
-
getDeleteSingleTenantHsmInstance
SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance getDeleteSingleTenantHsmInstance()Delete the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. Deleting a [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] will make all [CryptoKeys][google.cloud.kms.v1.CryptoKey] attached to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] unusable. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [DISABLED][google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED] or [PENDING_TWO_FACTOR_AUTH_REGISTRATION][google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11;- Returns:
- The deleteSingleTenantHsmInstance.
-
getDeleteSingleTenantHsmInstanceOrBuilder
SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstanceOrBuilder getDeleteSingleTenantHsmInstanceOrBuilder()Delete the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. Deleting a [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] will make all [CryptoKeys][google.cloud.kms.v1.CryptoKey] attached to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] unusable. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [DISABLED][google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED] or [PENDING_TWO_FACTOR_AUTH_REGISTRATION][google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.DeleteSingleTenantHsmInstance delete_single_tenant_hsm_instance = 11; -
hasAddQuorumMember
boolean hasAddQuorumMember()Add a quorum member to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This will increase the [total_approver_count][google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count] by 1. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;- Returns:
- Whether the addQuorumMember field is set.
-
getAddQuorumMember
SingleTenantHsmInstanceProposal.AddQuorumMember getAddQuorumMember()Add a quorum member to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This will increase the [total_approver_count][google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count] by 1. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12;- Returns:
- The addQuorumMember.
-
getAddQuorumMemberOrBuilder
SingleTenantHsmInstanceProposal.AddQuorumMemberOrBuilder getAddQuorumMemberOrBuilder()Add a quorum member to the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This will increase the [total_approver_count][google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count] by 1. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.AddQuorumMember add_quorum_member = 12; -
hasRemoveQuorumMember
boolean hasRemoveQuorumMember()Remove a quorum member from the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This will reduce [total_approver_count][google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count] by 1. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;- Returns:
- Whether the removeQuorumMember field is set.
-
getRemoveQuorumMember
SingleTenantHsmInstanceProposal.RemoveQuorumMember getRemoveQuorumMember()Remove a quorum member from the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This will reduce [total_approver_count][google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count] by 1. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13;- Returns:
- The removeQuorumMember.
-
getRemoveQuorumMemberOrBuilder
SingleTenantHsmInstanceProposal.RemoveQuorumMemberOrBuilder getRemoveQuorumMemberOrBuilder()Remove a quorum member from the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This will reduce [total_approver_count][google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count] by 1. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RemoveQuorumMember remove_quorum_member = 13; -
hasRefreshSingleTenantHsmInstance
boolean hasRefreshSingleTenantHsmInstance()Refreshes the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This operation must be performed periodically to keep the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] active. This operation must be performed before [unrefreshed_duration_until_disable][google.cloud.kms.v1.SingleTenantHsmInstance.unrefreshed_duration_until_disable] has passed. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;- Returns:
- Whether the refreshSingleTenantHsmInstance field is set.
-
getRefreshSingleTenantHsmInstance
SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance getRefreshSingleTenantHsmInstance()Refreshes the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This operation must be performed periodically to keep the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] active. This operation must be performed before [unrefreshed_duration_until_disable][google.cloud.kms.v1.SingleTenantHsmInstance.unrefreshed_duration_until_disable] has passed. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17;- Returns:
- The refreshSingleTenantHsmInstance.
-
getRefreshSingleTenantHsmInstanceOrBuilder
SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstanceOrBuilder getRefreshSingleTenantHsmInstanceOrBuilder()Refreshes the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. This operation must be performed periodically to keep the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] active. This operation must be performed before [unrefreshed_duration_until_disable][google.cloud.kms.v1.SingleTenantHsmInstance.unrefreshed_duration_until_disable] has passed. The [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] must be in the [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RefreshSingleTenantHsmInstance refresh_single_tenant_hsm_instance = 17; -
hasUpgradeKeyTrust
boolean hasUpgradeKeyTrust()Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the [ACTIVE][CryptoKeyVersion.CryptoKeyVersionState.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.UpgradeKeyTrust upgrade_key_trust = 18;- Returns:
- Whether the upgradeKeyTrust field is set.
-
getUpgradeKeyTrust
SingleTenantHsmInstanceProposal.UpgradeKeyTrust getUpgradeKeyTrust()Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the [ACTIVE][CryptoKeyVersion.CryptoKeyVersionState.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.UpgradeKeyTrust upgrade_key_trust = 18;- Returns:
- The upgradeKeyTrust.
-
getUpgradeKeyTrustOrBuilder
SingleTenantHsmInstanceProposal.UpgradeKeyTrustOrBuilder getUpgradeKeyTrustOrBuilder()Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the [ACTIVE][CryptoKeyVersion.CryptoKeyVersionState.ACTIVE] state to perform this operation.
.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.UpgradeKeyTrust upgrade_key_trust = 18; -
getApprovalParametersCase
SingleTenantHsmInstanceProposal.ApprovalParametersCase getApprovalParametersCase() -
getExpirationCase
SingleTenantHsmInstanceProposal.ExpirationCase getExpirationCase() -
getOperationCase
SingleTenantHsmInstanceProposal.OperationCase getOperationCase()
-