Package com.google.cloud.kms.v1

Interface SingleTenantHsmInstanceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SingleTenantHsmInstance, SingleTenantHsmInstance.Builder
@Generated public interface SingleTenantHsmInstanceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. The resource name for this
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] in
 the format `projects/*/locations/*/singleTenantHsmInstances/*`.
      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/*`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] 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
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] 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
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] was
 created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateValue

      int getStateValue()
       Output only. The state of the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
      .google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      SingleTenantHsmInstance.State getState()
       Output only. The state of the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
      .google.cloud.kms.v1.SingleTenantHsmInstance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasQuorumAuth

      boolean hasQuorumAuth()
       Required. The quorum auth configuration for the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
      .google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the quorumAuth field is set.

    • getQuorumAuth

      SingleTenantHsmInstance.QuorumAuth getQuorumAuth()
       Required. The quorum auth configuration for the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
      .google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The quorumAuth.

    • getQuorumAuthOrBuilder

      SingleTenantHsmInstance.QuorumAuthOrBuilder getQuorumAuthOrBuilder()
       Required. The quorum auth configuration for the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
      .google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth quorum_auth = 4 [(.google.api.field_behavior) = REQUIRED];

    • hasDeleteTime

      boolean hasDeleteTime()
       Output only. The time at which the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] was
 deleted.
      .google.protobuf.Timestamp delete_time = 5 [(.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
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] was
 deleted.
      .google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
       Output only. The time at which the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] was
 deleted.
      .google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUnrefreshedDurationUntilDisable

      boolean hasUnrefreshedDurationUntilDisable()
       Output only. The system-defined duration that an instance can remain
 unrefreshed until it is automatically disabled. This will have a value of
 730 days.
      .google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the unrefreshedDurationUntilDisable field is set.

    • getUnrefreshedDurationUntilDisable

      com.google.protobuf.Duration getUnrefreshedDurationUntilDisable()
       Output only. The system-defined duration that an instance can remain
 unrefreshed until it is automatically disabled. This will have a value of
 730 days.
      .google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The unrefreshedDurationUntilDisable.

    • getUnrefreshedDurationUntilDisableOrBuilder

      com.google.protobuf.DurationOrBuilder getUnrefreshedDurationUntilDisableOrBuilder()
       Output only. The system-defined duration that an instance can remain
 unrefreshed until it is automatically disabled. This will have a value of
 730 days.
      .google.protobuf.Duration unrefreshed_duration_until_disable = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDisableTime

      boolean hasDisableTime()
       Output only. The time at which the instance will be automatically disabled
 if not refreshed. This field is updated upon creation and after each
 successful refresh operation and enable. A
 [RefreshSingleTenantHsmInstance][] operation must be made via a
 [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
 before this time otherwise the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] will
 become disabled.
      .google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the disableTime field is set.

    • getDisableTime

      com.google.protobuf.Timestamp getDisableTime()
       Output only. The time at which the instance will be automatically disabled
 if not refreshed. This field is updated upon creation and after each
 successful refresh operation and enable. A
 [RefreshSingleTenantHsmInstance][] operation must be made via a
 [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
 before this time otherwise the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] will
 become disabled.
      .google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The disableTime.

    • getDisableTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getDisableTimeOrBuilder()
       Output only. The time at which the instance will be automatically disabled
 if not refreshed. This field is updated upon creation and after each
 successful refresh operation and enable. A
 [RefreshSingleTenantHsmInstance][] operation must be made via a
 [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
 before this time otherwise the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] will
 become disabled.
      .google.protobuf.Timestamp disable_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getKeyPortabilityEnabled

      boolean getKeyPortabilityEnabled()
       Optional. Immutable. Indicates whether key portability is enabled for the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
 This can only be set at creation time. Key portability features are
 disabled by default.
      bool key_portability_enabled = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The keyPortabilityEnabled.