Package com.google.cloud.kms.v1

Class SingleTenantHsmInstance

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.SingleTenantHsmInstance
All Implemented Interfaces:
SingleTenantHsmInstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SingleTenantHsmInstance extends com.google.protobuf.GeneratedMessage implements SingleTenantHsmInstanceOrBuilder
 A [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 represents a single-tenant HSM instance. It can be used for creating
 [CryptoKeys][google.cloud.kms.v1.CryptoKey] with a
 [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
 [HSM_SINGLE_TENANT][CryptoKeyVersion.ProtectionLevel.HSM_SINGLE_TENANT], as
 well as performing cryptographic operations using keys created within the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
Protobuf type google.cloud.kms.v1.SingleTenantHsmInstance
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • QUORUM_AUTH_FIELD_NUMBER

      public static final int QUORUM_AUTH_FIELD_NUMBER
      See Also:

    • DELETE_TIME_FIELD_NUMBER

      public static final int DELETE_TIME_FIELD_NUMBER
      See Also:

    • UNREFRESHED_DURATION_UNTIL_DISABLE_FIELD_NUMBER

      public static final int UNREFRESHED_DURATION_UNTIL_DISABLE_FIELD_NUMBER
      See Also:

    • DISABLE_TIME_FIELD_NUMBER

      public static final int DISABLE_TIME_FIELD_NUMBER
      See Also:

    • KEY_PORTABILITY_ENABLED_FIELD_NUMBER

      public static final int KEY_PORTABILITY_ENABLED_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

      public 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];
      Specified by:
      hasCreateTime in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface SingleTenantHsmInstanceOrBuilder

    • getStateValue

      public 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];
      Specified by:
      getStateValue in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public 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];
      Specified by:
      getState in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The state.

    • hasQuorumAuth

      public 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];
      Specified by:
      hasQuorumAuth in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      Whether the quorumAuth field is set.

    • getQuorumAuth

      public 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];
      Specified by:
      getQuorumAuth in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The quorumAuth.

    • getQuorumAuthOrBuilder

      public 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];
      Specified by:
      getQuorumAuthOrBuilder in interface SingleTenantHsmInstanceOrBuilder

    • hasDeleteTime

      public 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];
      Specified by:
      hasDeleteTime in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      public 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];
      Specified by:
      getDeleteTime in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      public 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];
      Specified by:
      getDeleteTimeOrBuilder in interface SingleTenantHsmInstanceOrBuilder

    • hasUnrefreshedDurationUntilDisable

      public 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];
      Specified by:
      hasUnrefreshedDurationUntilDisable in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      Whether the unrefreshedDurationUntilDisable field is set.

    • getUnrefreshedDurationUntilDisable

      public 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];
      Specified by:
      getUnrefreshedDurationUntilDisable in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The unrefreshedDurationUntilDisable.

    • getUnrefreshedDurationUntilDisableOrBuilder

      public 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];
      Specified by:
      getUnrefreshedDurationUntilDisableOrBuilder in interface SingleTenantHsmInstanceOrBuilder

    • hasDisableTime

      public 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];
      Specified by:
      hasDisableTime in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      Whether the disableTime field is set.

    • getDisableTime

      public 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];
      Specified by:
      getDisableTime in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The disableTime.

    • getDisableTimeOrBuilder

      public 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];
      Specified by:
      getDisableTimeOrBuilder in interface SingleTenantHsmInstanceOrBuilder

    • getKeyPortabilityEnabled

      public 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];
      Specified by:
      getKeyPortabilityEnabled in interface SingleTenantHsmInstanceOrBuilder
      Returns:
      The keyPortabilityEnabled.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SingleTenantHsmInstance parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SingleTenantHsmInstance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SingleTenantHsmInstance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SingleTenantHsmInstance.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SingleTenantHsmInstance.Builder newBuilder()

    • newBuilder

      public static SingleTenantHsmInstance.Builder newBuilder(SingleTenantHsmInstance prototype)

    • toBuilder

      public SingleTenantHsmInstance.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SingleTenantHsmInstance.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SingleTenantHsmInstance getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SingleTenantHsmInstance> parser()

    • getParserForType

      public com.google.protobuf.Parser<SingleTenantHsmInstance> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SingleTenantHsmInstance getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder