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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeHsmResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`availabilityZone()`	The Availability Zone that the HSM is in.
`static DescribeHsmResponse.Builder`	`builder()`
`String`	`eniId()`	The identifier of the elastic network interface (ENI) attached to the HSM.
`String`	`eniIp()`	The IP address assigned to the HSM's ENI.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPartitions()`	For responses, this returns true if the service returned a value for the Partitions property.
`String`	`hsmArn()`	The ARN of the HSM.
`String`	`hsmType()`	The HSM model type.
`String`	`iamRoleArn()`	The ARN of the IAM role assigned to the HSM.
`List<String>`	`partitions()`	The list of partitions on the HSM.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeHsmResponse.Builder>`	`serializableBuilderClass()`
`String`	`serialNumber()`	The serial number of the HSM.
`String`	`serverCertLastUpdated()`	The date and time that the server certificate was last updated.
`String`	`serverCertUri()`	The URI of the certificate server.
`String`	`softwareVersion()`	The HSM software version.
`String`	`sshKeyLastUpdated()`	The date and time that the SSH key was last updated.
`String`	`sshPublicKey()`	The public SSH key.
`HsmStatus`	`status()`	The status of the HSM.
`String`	`statusAsString()`	The status of the HSM.
`String`	`statusDetails()`	Contains additional information about the status of the HSM.
`String`	`subnetId()`	The identifier of the subnet that the HSM is in.
`String`	`subscriptionEndDate()`	The subscription end date.
`String`	`subscriptionStartDate()`	The subscription start date.
`SubscriptionType`	`subscriptionType()`	Returns the value of the SubscriptionType property for this object.
`String`	`subscriptionTypeAsString()`	Returns the value of the SubscriptionType property for this object.
`DescribeHsmResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vendorName()`	The name of the HSM vendor.
`String`	`vpcId()`	The identifier of the VPC that the HSM is in.

Methods inherited from class software.amazon.awssdk.services.cloudhsm.model.CloudHsmResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    HsmStatus
  - 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:
    
    HsmStatus
  - 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:
    
    SubscriptionType
  - 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:
    
    SubscriptionType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeHsmResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cloudhsm.model.CloudHsmResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hsmArn

status

statusAsString

statusDetails

availabilityZone

eniId

eniIp

subscriptionType

subscriptionTypeAsString

subscriptionStartDate

subscriptionEndDate

vpcId

subnetId

iamRoleArn

serialNumber

vendorName

hsmType

softwareVersion

sshPublicKey

sshKeyLastUpdated

serverCertUri

serverCertLastUpdated

hasPartitions

partitions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField