software.amazon.awssdk.services.cloudhsm.model

Class DescribeHsmRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudhsm.model.CloudHSMRequest

software.amazon.awssdk.services.cloudhsm.model.DescribeHsmRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeHsmRequest.Builder,DescribeHsmRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeHsmRequest
extends CloudHSMRequest
implements ToCopyableBuilder<DescribeHsmRequest.Builder,DescribeHsmRequest>

Contains the inputs for the DescribeHsm operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeHsmRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeHsmRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	hsmArn() The ARN of the HSM.
String	hsmSerialNumber() The serial number of the HSM.
static Class<? extends DescribeHsmRequest.Builder>	serializableBuilderClass()
DescribeHsmRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hsmArn

public String hsmArn()

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

Returns:

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

hsmSerialNumber

public String hsmSerialNumber()

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

Returns:

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

toBuilder

public DescribeHsmRequest.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<DescribeHsmRequest.Builder,DescribeHsmRequest>

Specified by:

toBuilder in class CloudHSMRequest

Returns:

a builder for type T

builder

public static DescribeHsmRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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