Class DescribeHsmResult

java.lang.Object
com.amazonaws.services.cloudhsm.model.DescribeHsmResult
All Implemented Interfaces:
Serializable, Cloneable

public class DescribeHsmResult extends Object implements Serializable, Cloneable

Contains the output of the DescribeHsm operation.

See Also:
  • Constructor Details

    • DescribeHsmResult

      public DescribeHsmResult()
  • Method Details

    • setHsmArn

      public void setHsmArn(String hsmArn)

      The ARN of the HSM.

      Parameters:
      hsmArn - The ARN of the HSM.
    • getHsmArn

      public String getHsmArn()

      The ARN of the HSM.

      Returns:
      The ARN of the HSM.
    • withHsmArn

      public DescribeHsmResult withHsmArn(String hsmArn)

      The ARN of the HSM.

      Parameters:
      hsmArn - The ARN of the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatus

      public void setStatus(String status)

      The status of the HSM.

      Parameters:
      status - The status of the HSM.
      See Also:
    • getStatus

      public String getStatus()

      The status of the HSM.

      Returns:
      The status of the HSM.
      See Also:
    • withStatus

      public DescribeHsmResult withStatus(String status)

      The status of the HSM.

      Parameters:
      status - The status of the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setStatus

      public void setStatus(HsmStatus status)

      The status of the HSM.

      Parameters:
      status - The status of the HSM.
      See Also:
    • withStatus

      public DescribeHsmResult withStatus(HsmStatus status)

      The status of the HSM.

      Parameters:
      status - The status of the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setStatusDetails

      public void setStatusDetails(String statusDetails)

      Contains additional information about the status of the HSM.

      Parameters:
      statusDetails - Contains additional information about the status of the HSM.
    • getStatusDetails

      public String getStatusDetails()

      Contains additional information about the status of the HSM.

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

      public DescribeHsmResult withStatusDetails(String statusDetails)

      Contains additional information about the status of the HSM.

      Parameters:
      statusDetails - Contains additional information about the status of the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAvailabilityZone

      public void setAvailabilityZone(String availabilityZone)

      The Availability Zone that the HSM is in.

      Parameters:
      availabilityZone - The Availability Zone that the HSM is in.
    • getAvailabilityZone

      public String getAvailabilityZone()

      The Availability Zone that the HSM is in.

      Returns:
      The Availability Zone that the HSM is in.
    • withAvailabilityZone

      public DescribeHsmResult withAvailabilityZone(String availabilityZone)

      The Availability Zone that the HSM is in.

      Parameters:
      availabilityZone - The Availability Zone that the HSM is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEniId

      public void setEniId(String eniId)

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

      Parameters:
      eniId - The identifier of the elastic network interface (ENI) attached to the HSM.
    • getEniId

      public String getEniId()

      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.
    • withEniId

      public DescribeHsmResult withEniId(String eniId)

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

      Parameters:
      eniId - The identifier of the elastic network interface (ENI) attached to the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEniIp

      public void setEniIp(String eniIp)

      The IP address assigned to the HSM's ENI.

      Parameters:
      eniIp - The IP address assigned to the HSM's ENI.
    • getEniIp

      public String getEniIp()

      The IP address assigned to the HSM's ENI.

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

      public DescribeHsmResult withEniIp(String eniIp)

      The IP address assigned to the HSM's ENI.

      Parameters:
      eniIp - The IP address assigned to the HSM's ENI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSubscriptionType

      public void setSubscriptionType(String subscriptionType)
      Parameters:
      subscriptionType -
      See Also:
    • getSubscriptionType

      public String getSubscriptionType()
      Returns:
      See Also:
    • withSubscriptionType

      public DescribeHsmResult withSubscriptionType(String subscriptionType)
      Parameters:
      subscriptionType -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setSubscriptionType

      public void setSubscriptionType(SubscriptionType subscriptionType)
      Parameters:
      subscriptionType -
      See Also:
    • withSubscriptionType

      public DescribeHsmResult withSubscriptionType(SubscriptionType subscriptionType)
      Parameters:
      subscriptionType -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setSubscriptionStartDate

      public void setSubscriptionStartDate(String subscriptionStartDate)

      The subscription start date.

      Parameters:
      subscriptionStartDate - The subscription start date.
    • getSubscriptionStartDate

      public String getSubscriptionStartDate()

      The subscription start date.

      Returns:
      The subscription start date.
    • withSubscriptionStartDate

      public DescribeHsmResult withSubscriptionStartDate(String subscriptionStartDate)

      The subscription start date.

      Parameters:
      subscriptionStartDate - The subscription start date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSubscriptionEndDate

      public void setSubscriptionEndDate(String subscriptionEndDate)

      The subscription end date.

      Parameters:
      subscriptionEndDate - The subscription end date.
    • getSubscriptionEndDate

      public String getSubscriptionEndDate()

      The subscription end date.

      Returns:
      The subscription end date.
    • withSubscriptionEndDate

      public DescribeHsmResult withSubscriptionEndDate(String subscriptionEndDate)

      The subscription end date.

      Parameters:
      subscriptionEndDate - The subscription end date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setVpcId

      public void setVpcId(String vpcId)

      The identifier of the VPC that the HSM is in.

      Parameters:
      vpcId - The identifier of the VPC that the HSM is in.
    • getVpcId

      public String getVpcId()

      The identifier of the VPC that the HSM is in.

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

      public DescribeHsmResult withVpcId(String vpcId)

      The identifier of the VPC that the HSM is in.

      Parameters:
      vpcId - The identifier of the VPC that the HSM is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSubnetId

      public void setSubnetId(String subnetId)

      The identifier of the subnet that the HSM is in.

      Parameters:
      subnetId - The identifier of the subnet that the HSM is in.
    • getSubnetId

      public String getSubnetId()

      The identifier of the subnet that the HSM is in.

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

      public DescribeHsmResult withSubnetId(String subnetId)

      The identifier of the subnet that the HSM is in.

      Parameters:
      subnetId - The identifier of the subnet that the HSM is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIamRoleArn

      public void setIamRoleArn(String iamRoleArn)

      The ARN of the IAM role assigned to the HSM.

      Parameters:
      iamRoleArn - The ARN of the IAM role assigned to the HSM.
    • getIamRoleArn

      public String getIamRoleArn()

      The ARN of the IAM role assigned to the HSM.

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

      public DescribeHsmResult withIamRoleArn(String iamRoleArn)

      The ARN of the IAM role assigned to the HSM.

      Parameters:
      iamRoleArn - The ARN of the IAM role assigned to the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSerialNumber

      public void setSerialNumber(String serialNumber)

      The serial number of the HSM.

      Parameters:
      serialNumber - The serial number of the HSM.
    • getSerialNumber

      public String getSerialNumber()

      The serial number of the HSM.

      Returns:
      The serial number of the HSM.
    • withSerialNumber

      public DescribeHsmResult withSerialNumber(String serialNumber)

      The serial number of the HSM.

      Parameters:
      serialNumber - The serial number of the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setVendorName

      public void setVendorName(String vendorName)

      The name of the HSM vendor.

      Parameters:
      vendorName - The name of the HSM vendor.
    • getVendorName

      public String getVendorName()

      The name of the HSM vendor.

      Returns:
      The name of the HSM vendor.
    • withVendorName

      public DescribeHsmResult withVendorName(String vendorName)

      The name of the HSM vendor.

      Parameters:
      vendorName - The name of the HSM vendor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setHsmType

      public void setHsmType(String hsmType)

      The HSM model type.

      Parameters:
      hsmType - The HSM model type.
    • getHsmType

      public String getHsmType()

      The HSM model type.

      Returns:
      The HSM model type.
    • withHsmType

      public DescribeHsmResult withHsmType(String hsmType)

      The HSM model type.

      Parameters:
      hsmType - The HSM model type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSoftwareVersion

      public void setSoftwareVersion(String softwareVersion)

      The HSM software version.

      Parameters:
      softwareVersion - The HSM software version.
    • getSoftwareVersion

      public String getSoftwareVersion()

      The HSM software version.

      Returns:
      The HSM software version.
    • withSoftwareVersion

      public DescribeHsmResult withSoftwareVersion(String softwareVersion)

      The HSM software version.

      Parameters:
      softwareVersion - The HSM software version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSshPublicKey

      public void setSshPublicKey(String sshPublicKey)

      The public SSH key.

      Parameters:
      sshPublicKey - The public SSH key.
    • getSshPublicKey

      public String getSshPublicKey()

      The public SSH key.

      Returns:
      The public SSH key.
    • withSshPublicKey

      public DescribeHsmResult withSshPublicKey(String sshPublicKey)

      The public SSH key.

      Parameters:
      sshPublicKey - The public SSH key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSshKeyLastUpdated

      public void setSshKeyLastUpdated(String sshKeyLastUpdated)

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

      Parameters:
      sshKeyLastUpdated - The date and time that the SSH key was last updated.
    • getSshKeyLastUpdated

      public String getSshKeyLastUpdated()

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

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

      public DescribeHsmResult withSshKeyLastUpdated(String sshKeyLastUpdated)

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

      Parameters:
      sshKeyLastUpdated - The date and time that the SSH key was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setServerCertUri

      public void setServerCertUri(String serverCertUri)

      The URI of the certificate server.

      Parameters:
      serverCertUri - The URI of the certificate server.
    • getServerCertUri

      public String getServerCertUri()

      The URI of the certificate server.

      Returns:
      The URI of the certificate server.
    • withServerCertUri

      public DescribeHsmResult withServerCertUri(String serverCertUri)

      The URI of the certificate server.

      Parameters:
      serverCertUri - The URI of the certificate server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setServerCertLastUpdated

      public void setServerCertLastUpdated(String serverCertLastUpdated)

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

      Parameters:
      serverCertLastUpdated - The date and time that the server certificate was last updated.
    • getServerCertLastUpdated

      public String getServerCertLastUpdated()

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

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

      public DescribeHsmResult withServerCertLastUpdated(String serverCertLastUpdated)

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

      Parameters:
      serverCertLastUpdated - The date and time that the server certificate was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getPartitions

      public List<String> getPartitions()

      The list of partitions on the HSM.

      Returns:
      The list of partitions on the HSM.
    • setPartitions

      public void setPartitions(Collection<String> partitions)

      The list of partitions on the HSM.

      Parameters:
      partitions - The list of partitions on the HSM.
    • withPartitions

      public DescribeHsmResult withPartitions(String... partitions)

      The list of partitions on the HSM.

      NOTE: This method appends the values to the existing list (if any). Use setPartitions(java.util.Collection) or withPartitions(java.util.Collection) if you want to override the existing values.

      Parameters:
      partitions - The list of partitions on the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withPartitions

      public DescribeHsmResult withPartitions(Collection<String> partitions)

      The list of partitions on the HSM.

      Parameters:
      partitions - The list of partitions on the HSM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeHsmResult clone()
      Overrides:
      clone in class Object