com.amazonaws.services.cloudhsm.model

Class DescribeHsmRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudhsm.model.DescribeHsmRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeHsmRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeHsm operation.

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

See Also:

AWSCloudHSM.describeHsm(DescribeHsmRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeHsmRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeHsmRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getHsmArn() The ARN of the HSM.
String	getHsmSerialNumber() The serial number of the HSM.
int	hashCode()
void	setHsmArn(String hsmArn) The ARN of the HSM.
void	setHsmSerialNumber(String hsmSerialNumber) The serial number of the HSM.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeHsmRequest	withHsmArn(String hsmArn) The ARN of the HSM.
DescribeHsmRequest	withHsmSerialNumber(String hsmSerialNumber) The serial number of the HSM.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeHsmRequest

public DescribeHsmRequest()

Method Detail

getHsmArn

public String getHsmArn()

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}

Returns:

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

setHsmArn

public void setHsmArn(String hsmArn)

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}

Parameters:

hsmArn - The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

withHsmArn

public DescribeHsmRequest withHsmArn(String hsmArn)

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}

Parameters:

hsmArn - The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

Returns:

A reference to this updated object so that method calls can be chained together.

getHsmSerialNumber

public String getHsmSerialNumber()

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

Constraints:
Pattern: \d{1,16}

Returns:

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

setHsmSerialNumber

public void setHsmSerialNumber(String hsmSerialNumber)

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

Constraints:
Pattern: \d{1,16}

Parameters:

hsmSerialNumber - The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

withHsmSerialNumber

public DescribeHsmRequest withHsmSerialNumber(String hsmSerialNumber)

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: \d{1,16}

Parameters:

hsmSerialNumber - The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

Returns:

A reference to this updated 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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeHsmRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()