/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudhsm.model; import java.io.Serializable; import javax.annotation.Generated; /** *
* Contains the output of the DescribeHsm operation. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeHsmResult extends com.amazonaws.AmazonWebServiceResult* The ARN of the HSM. *
*/ private String hsmArn; /** ** The status of the HSM. *
*/ private String status; /** ** Contains additional information about the status of the HSM. *
*/ private String statusDetails; /** ** The Availability Zone that the HSM is in. *
*/ private String availabilityZone; /** ** The identifier of the elastic network interface (ENI) attached to the HSM. *
*/ private String eniId; /** ** The IP address assigned to the HSM's ENI. *
*/ private String eniIp; private String subscriptionType; /** ** The subscription start date. *
*/ private String subscriptionStartDate; /** ** The subscription end date. *
*/ private String subscriptionEndDate; /** ** The identifier of the VPC that the HSM is in. *
*/ private String vpcId; /** ** The identifier of the subnet that the HSM is in. *
*/ private String subnetId; /** ** The ARN of the IAM role assigned to the HSM. *
*/ private String iamRoleArn; /** ** The serial number of the HSM. *
*/ private String serialNumber; /** ** The name of the HSM vendor. *
*/ private String vendorName; /** ** The HSM model type. *
*/ private String hsmType; /** ** The HSM software version. *
*/ private String softwareVersion; /** ** The public SSH key. *
*/ private String sshPublicKey; /** ** The date and time that the SSH key was last updated. *
*/ private String sshKeyLastUpdated; /** ** The URI of the certificate server. *
*/ private String serverCertUri; /** ** The date and time that the server certificate was last updated. *
*/ private String serverCertLastUpdated; /** ** The list of partitions on the HSM. *
*/ private com.amazonaws.internal.SdkInternalList* The ARN of the HSM. *
* * @param hsmArn * The ARN of the HSM. */ public void setHsmArn(String hsmArn) { this.hsmArn = hsmArn; } /** ** The ARN of the HSM. *
* * @return The ARN of the HSM. */ public String getHsmArn() { return this.hsmArn; } /** ** The ARN of the HSM. *
* * @param hsmArn * The ARN of the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withHsmArn(String hsmArn) { setHsmArn(hsmArn); return this; } /** ** The status of the HSM. *
* * @param status * The status of the HSM. * @see HsmStatus */ public void setStatus(String status) { this.status = status; } /** ** The status of the HSM. *
* * @return The status of the HSM. * @see HsmStatus */ public String getStatus() { return this.status; } /** ** The status of the HSM. *
* * @param status * The status of the HSM. * @return Returns a reference to this object so that method calls can be chained together. * @see HsmStatus */ public DescribeHsmResult withStatus(String status) { setStatus(status); return this; } /** ** The status of the HSM. *
* * @param status * The status of the HSM. * @see HsmStatus */ public void setStatus(HsmStatus status) { withStatus(status); } /** ** The status of the HSM. *
* * @param status * The status of the HSM. * @return Returns a reference to this object so that method calls can be chained together. * @see HsmStatus */ public DescribeHsmResult withStatus(HsmStatus status) { this.status = status.toString(); return this; } /** ** Contains additional information about the status of the HSM. *
* * @param statusDetails * Contains additional information about the status of the HSM. */ public void setStatusDetails(String statusDetails) { this.statusDetails = statusDetails; } /** ** Contains additional information about the status of the HSM. *
* * @return Contains additional information about the status of the HSM. */ public String getStatusDetails() { return this.statusDetails; } /** ** Contains additional information about the status of the HSM. *
* * @param statusDetails * Contains additional information about the status of the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withStatusDetails(String statusDetails) { setStatusDetails(statusDetails); return this; } /** ** The Availability Zone that the HSM is in. *
* * @param availabilityZone * The Availability Zone that the HSM is in. */ public void setAvailabilityZone(String availabilityZone) { this.availabilityZone = availabilityZone; } /** ** The Availability Zone that the HSM is in. *
* * @return The Availability Zone that the HSM is in. */ public String getAvailabilityZone() { return this.availabilityZone; } /** ** The Availability Zone that the HSM is in. *
* * @param availabilityZone * The Availability Zone that the HSM is in. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withAvailabilityZone(String availabilityZone) { setAvailabilityZone(availabilityZone); return this; } /** ** The identifier of the elastic network interface (ENI) attached to the HSM. *
* * @param eniId * The identifier of the elastic network interface (ENI) attached to the HSM. */ public void setEniId(String eniId) { this.eniId = eniId; } /** ** The identifier of the elastic network interface (ENI) attached to the HSM. *
* * @return The identifier of the elastic network interface (ENI) attached to the HSM. */ public String getEniId() { return this.eniId; } /** ** The identifier of the elastic network interface (ENI) attached to the HSM. *
* * @param eniId * The identifier of the elastic network interface (ENI) attached to the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withEniId(String eniId) { setEniId(eniId); return this; } /** ** The IP address assigned to the HSM's ENI. *
* * @param eniIp * The IP address assigned to the HSM's ENI. */ public void setEniIp(String eniIp) { this.eniIp = eniIp; } /** ** The IP address assigned to the HSM's ENI. *
* * @return The IP address assigned to the HSM's ENI. */ public String getEniIp() { return this.eniIp; } /** ** The IP address assigned to the HSM's ENI. *
* * @param eniIp * The IP address assigned to the HSM's ENI. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withEniIp(String eniIp) { setEniIp(eniIp); return this; } /** * @param subscriptionType * @see SubscriptionType */ public void setSubscriptionType(String subscriptionType) { this.subscriptionType = subscriptionType; } /** * @return * @see SubscriptionType */ public String getSubscriptionType() { return this.subscriptionType; } /** * @param subscriptionType * @return Returns a reference to this object so that method calls can be chained together. * @see SubscriptionType */ public DescribeHsmResult withSubscriptionType(String subscriptionType) { setSubscriptionType(subscriptionType); return this; } /** * @param subscriptionType * @see SubscriptionType */ public void setSubscriptionType(SubscriptionType subscriptionType) { withSubscriptionType(subscriptionType); } /** * @param subscriptionType * @return Returns a reference to this object so that method calls can be chained together. * @see SubscriptionType */ public DescribeHsmResult withSubscriptionType(SubscriptionType subscriptionType) { this.subscriptionType = subscriptionType.toString(); return this; } /** ** The subscription start date. *
* * @param subscriptionStartDate * The subscription start date. */ public void setSubscriptionStartDate(String subscriptionStartDate) { this.subscriptionStartDate = subscriptionStartDate; } /** ** The subscription start date. *
* * @return The subscription start date. */ public String getSubscriptionStartDate() { return this.subscriptionStartDate; } /** ** The subscription start date. *
* * @param subscriptionStartDate * The subscription start date. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSubscriptionStartDate(String subscriptionStartDate) { setSubscriptionStartDate(subscriptionStartDate); return this; } /** ** The subscription end date. *
* * @param subscriptionEndDate * The subscription end date. */ public void setSubscriptionEndDate(String subscriptionEndDate) { this.subscriptionEndDate = subscriptionEndDate; } /** ** The subscription end date. *
* * @return The subscription end date. */ public String getSubscriptionEndDate() { return this.subscriptionEndDate; } /** ** The subscription end date. *
* * @param subscriptionEndDate * The subscription end date. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSubscriptionEndDate(String subscriptionEndDate) { setSubscriptionEndDate(subscriptionEndDate); return this; } /** ** The identifier of the VPC that the HSM is in. *
* * @param vpcId * The identifier of the VPC that the HSM is in. */ public void setVpcId(String vpcId) { this.vpcId = vpcId; } /** ** The identifier of the VPC that the HSM is in. *
* * @return The identifier of the VPC that the HSM is in. */ public String getVpcId() { return this.vpcId; } /** ** The identifier of the VPC that the HSM is in. *
* * @param vpcId * The identifier of the VPC that the HSM is in. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withVpcId(String vpcId) { setVpcId(vpcId); return this; } /** ** The identifier of the subnet that the HSM is in. *
* * @param subnetId * The identifier of the subnet that the HSM is in. */ public void setSubnetId(String subnetId) { this.subnetId = subnetId; } /** ** The identifier of the subnet that the HSM is in. *
* * @return The identifier of the subnet that the HSM is in. */ public String getSubnetId() { return this.subnetId; } /** ** The identifier of the subnet that the HSM is in. *
* * @param subnetId * The identifier of the subnet that the HSM is in. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSubnetId(String subnetId) { setSubnetId(subnetId); return this; } /** ** The ARN of the IAM role assigned to the HSM. *
* * @param iamRoleArn * The ARN of the IAM role assigned to the HSM. */ public void setIamRoleArn(String iamRoleArn) { this.iamRoleArn = iamRoleArn; } /** ** The ARN of the IAM role assigned to the HSM. *
* * @return The ARN of the IAM role assigned to the HSM. */ public String getIamRoleArn() { return this.iamRoleArn; } /** ** The ARN of the IAM role assigned to the HSM. *
* * @param iamRoleArn * The ARN of the IAM role assigned to the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withIamRoleArn(String iamRoleArn) { setIamRoleArn(iamRoleArn); return this; } /** ** The serial number of the HSM. *
* * @param serialNumber * The serial number of the HSM. */ public void setSerialNumber(String serialNumber) { this.serialNumber = serialNumber; } /** ** The serial number of the HSM. *
* * @return The serial number of the HSM. */ public String getSerialNumber() { return this.serialNumber; } /** ** The serial number of the HSM. *
* * @param serialNumber * The serial number of the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSerialNumber(String serialNumber) { setSerialNumber(serialNumber); return this; } /** ** The name of the HSM vendor. *
* * @param vendorName * The name of the HSM vendor. */ public void setVendorName(String vendorName) { this.vendorName = vendorName; } /** ** The name of the HSM vendor. *
* * @return The name of the HSM vendor. */ public String getVendorName() { return this.vendorName; } /** ** The name of the HSM vendor. *
* * @param vendorName * The name of the HSM vendor. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withVendorName(String vendorName) { setVendorName(vendorName); return this; } /** ** The HSM model type. *
* * @param hsmType * The HSM model type. */ public void setHsmType(String hsmType) { this.hsmType = hsmType; } /** ** The HSM model type. *
* * @return The HSM model type. */ public String getHsmType() { return this.hsmType; } /** ** The HSM model type. *
* * @param hsmType * The HSM model type. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withHsmType(String hsmType) { setHsmType(hsmType); return this; } /** ** The HSM software version. *
* * @param softwareVersion * The HSM software version. */ public void setSoftwareVersion(String softwareVersion) { this.softwareVersion = softwareVersion; } /** ** The HSM software version. *
* * @return The HSM software version. */ public String getSoftwareVersion() { return this.softwareVersion; } /** ** The HSM software version. *
* * @param softwareVersion * The HSM software version. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSoftwareVersion(String softwareVersion) { setSoftwareVersion(softwareVersion); return this; } /** ** The public SSH key. *
* * @param sshPublicKey * The public SSH key. */ public void setSshPublicKey(String sshPublicKey) { this.sshPublicKey = sshPublicKey; } /** ** The public SSH key. *
* * @return The public SSH key. */ public String getSshPublicKey() { return this.sshPublicKey; } /** ** The public SSH key. *
* * @param sshPublicKey * The public SSH key. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSshPublicKey(String sshPublicKey) { setSshPublicKey(sshPublicKey); return this; } /** ** The date and time that the SSH key was last updated. *
* * @param sshKeyLastUpdated * The date and time that the SSH key was last updated. */ public void setSshKeyLastUpdated(String sshKeyLastUpdated) { this.sshKeyLastUpdated = sshKeyLastUpdated; } /** ** The date and time that the SSH key was last updated. *
* * @return The date and time that the SSH key was last updated. */ public String getSshKeyLastUpdated() { return this.sshKeyLastUpdated; } /** ** The date and time that the SSH key was last updated. *
* * @param sshKeyLastUpdated * The date and time that the SSH key was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withSshKeyLastUpdated(String sshKeyLastUpdated) { setSshKeyLastUpdated(sshKeyLastUpdated); return this; } /** ** The URI of the certificate server. *
* * @param serverCertUri * The URI of the certificate server. */ public void setServerCertUri(String serverCertUri) { this.serverCertUri = serverCertUri; } /** ** The URI of the certificate server. *
* * @return The URI of the certificate server. */ public String getServerCertUri() { return this.serverCertUri; } /** ** The URI of the certificate server. *
* * @param serverCertUri * The URI of the certificate server. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withServerCertUri(String serverCertUri) { setServerCertUri(serverCertUri); return this; } /** ** The date and time that the server certificate was last updated. *
* * @param serverCertLastUpdated * The date and time that the server certificate was last updated. */ public void setServerCertLastUpdated(String serverCertLastUpdated) { this.serverCertLastUpdated = serverCertLastUpdated; } /** ** The date and time that the server certificate was last updated. *
* * @return The date and time that the server certificate was last updated. */ public String getServerCertLastUpdated() { return this.serverCertLastUpdated; } /** ** The date and time that the server certificate was last updated. *
* * @param serverCertLastUpdated * The date and time that the server certificate was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withServerCertLastUpdated(String serverCertLastUpdated) { setServerCertLastUpdated(serverCertLastUpdated); return this; } /** ** The list of partitions on the HSM. *
* * @return The list of partitions on the HSM. */ public java.util.List* The list of partitions on the HSM. *
* * @param partitions * The list of partitions on the HSM. */ public void setPartitions(java.util.Collection* The list of partitions on the HSM. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setPartitions(java.util.Collection)} or {@link #withPartitions(java.util.Collection)} if you want to * override the existing values. *
* * @param partitions * The list of partitions on the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withPartitions(String... partitions) { if (this.partitions == null) { setPartitions(new com.amazonaws.internal.SdkInternalList* The list of partitions on the HSM. *
* * @param partitions * The list of partitions on the HSM. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeHsmResult withPartitions(java.util.Collection