Class DescribeHsmResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudhsm.model.CloudHsmResponse
software.amazon.awssdk.services.cloudhsm.model.DescribeHsmResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeHsmResponse extends CloudHsmResponse implements ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>

Contains the output of the DescribeHsm operation.

  • Method Details

    • hsmArn

      public final String hsmArn()

      The ARN of the HSM.

      Returns:
      The ARN of the HSM.

    • status

      public final HsmStatus status()

      The status of the HSM.

      If the service returns an enum value that is not available in the current SDK version, status will return HsmStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the HSM.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the HSM.

      If the service returns an enum value that is not available in the current SDK version, status will return HsmStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the HSM.
      See Also:

    • statusDetails

      public final String statusDetails()

      Contains additional information about the status of the HSM.

      Returns:
      Contains additional information about the status of the HSM.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone that the HSM is in.

      Returns:
      The Availability Zone that the HSM is in.

    • eniId

      public final String eniId()

      The identifier of the elastic network interface (ENI) attached to the HSM.

      Returns:
      The identifier of the elastic network interface (ENI) attached to the HSM.

    • eniIp

      public final String eniIp()

      The IP address assigned to the HSM's ENI.

      Returns:
      The IP address assigned to the HSM's ENI.

    • subscriptionType

      public final SubscriptionType subscriptionType()
      Returns the value of the SubscriptionType property for this object.

      If the service returns an enum value that is not available in the current SDK version, subscriptionType will return SubscriptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionTypeAsString().

      Returns:
      The value of the SubscriptionType property for this object.
      See Also:

    • subscriptionTypeAsString

      public final String subscriptionTypeAsString()
      Returns the value of the SubscriptionType property for this object.

      If the service returns an enum value that is not available in the current SDK version, subscriptionType will return SubscriptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionTypeAsString().

      Returns:
      The value of the SubscriptionType property for this object.
      See Also:

    • subscriptionStartDate

      public final String subscriptionStartDate()

      The subscription start date.

      Returns:
      The subscription start date.

    • subscriptionEndDate

      public final String subscriptionEndDate()

      The subscription end date.

      Returns:
      The subscription end date.

    • vpcId

      public final String vpcId()

      The identifier of the VPC that the HSM is in.

      Returns:
      The identifier of the VPC that the HSM is in.

    • subnetId

      public final String subnetId()

      The identifier of the subnet that the HSM is in.

      Returns:
      The identifier of the subnet that the HSM is in.

    • iamRoleArn

      public final String iamRoleArn()

      The ARN of the IAM role assigned to the HSM.

      Returns:
      The ARN of the IAM role assigned to the HSM.

    • serialNumber

      public final String serialNumber()

      The serial number of the HSM.

      Returns:
      The serial number of the HSM.

    • vendorName

      public final String vendorName()

      The name of the HSM vendor.

      Returns:
      The name of the HSM vendor.

    • hsmType

      public final String hsmType()

      The HSM model type.

      Returns:
      The HSM model type.

    • softwareVersion

      public final String softwareVersion()

      The HSM software version.

      Returns:
      The HSM software version.

    • sshPublicKey

      public final String sshPublicKey()

      The public SSH key.

      Returns:
      The public SSH key.

    • sshKeyLastUpdated

      public final String sshKeyLastUpdated()

      The date and time that the SSH key was last updated.

      Returns:
      The date and time that the SSH key was last updated.

    • serverCertUri

      public final String serverCertUri()

      The URI of the certificate server.

      Returns:
      The URI of the certificate server.

    • serverCertLastUpdated

      public final String serverCertLastUpdated()

      The date and time that the server certificate was last updated.

      Returns:
      The date and time that the server certificate was last updated.

    • hasPartitions

      public final boolean hasPartitions()
      For responses, this returns true if the service returned a value for the Partitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • partitions

      public final List<String> partitions()

      The list of partitions on the HSM.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPartitions() method.

      Returns:
      The list of partitions on the HSM.

    • toBuilder

      public DescribeHsmResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeHsmResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeHsmResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.