software.amazon.awssdk.services.cloudhsm.model

Class DescribeHapgResponse

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.DescribeHapgResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHapgResponse.Builder,DescribeHapgResponse>

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

Contains the output of the DescribeHapg action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeHapgResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeHapgResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	hapgArn() The ARN of the high-availability partition group.
String	hapgSerial() The serial number of the high-availability partition group.
int	hashCode()
boolean	hasHsmsLastActionFailed() For responses, this returns true if the service returned a value for the HsmsLastActionFailed property.
boolean	hasHsmsPendingDeletion() For responses, this returns true if the service returned a value for the HsmsPendingDeletion property.
boolean	hasHsmsPendingRegistration() For responses, this returns true if the service returned a value for the HsmsPendingRegistration property.
boolean	hasPartitionSerialList() For responses, this returns true if the service returned a value for the PartitionSerialList property.
List<String>	hsmsLastActionFailed()
List<String>	hsmsPendingDeletion()
List<String>	hsmsPendingRegistration()
String	label() The label for the high-availability partition group.
String	lastModifiedTimestamp() The date and time the high-availability partition group was last modified.
List<String>	partitionSerialList() The list of partition serial numbers that belong to the high-availability partition group.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeHapgResponse.Builder>	serializableBuilderClass()
CloudHsmObjectState	state() The state of the high-availability partition group.
String	stateAsString() The state of the high-availability partition group.
DescribeHapgResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hapgArn

public final String hapgArn()

The ARN of the high-availability partition group.

Returns:

The ARN of the high-availability partition group.

hapgSerial

public final String hapgSerial()

The serial number of the high-availability partition group.

Returns:

The serial number of the high-availability partition group.

hasHsmsLastActionFailed

public final boolean hasHsmsLastActionFailed()

For responses, this returns true if the service returned a value for the HsmsLastActionFailed 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.

hsmsLastActionFailed

public final List<String> hsmsLastActionFailed()

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 hasHsmsLastActionFailed() method.

Returns:

hasHsmsPendingDeletion

public final boolean hasHsmsPendingDeletion()

For responses, this returns true if the service returned a value for the HsmsPendingDeletion 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.

hsmsPendingDeletion

public final List<String> hsmsPendingDeletion()

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 hasHsmsPendingDeletion() method.

Returns:

hasHsmsPendingRegistration

public final boolean hasHsmsPendingRegistration()

For responses, this returns true if the service returned a value for the HsmsPendingRegistration 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.

hsmsPendingRegistration

public final List<String> hsmsPendingRegistration()

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 hasHsmsPendingRegistration() method.

Returns:

label

public final String label()

The label for the high-availability partition group.

Returns:

The label for the high-availability partition group.

lastModifiedTimestamp

public final String lastModifiedTimestamp()

The date and time the high-availability partition group was last modified.

Returns:

The date and time the high-availability partition group was last modified.

hasPartitionSerialList

public final boolean hasPartitionSerialList()

For responses, this returns true if the service returned a value for the PartitionSerialList 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.

partitionSerialList

public final List<String> partitionSerialList()

The list of partition serial numbers that belong to the high-availability partition group.

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 hasPartitionSerialList() method.

Returns:

The list of partition serial numbers that belong to the high-availability partition group.

state

public final CloudHsmObjectState state()

The state of the high-availability partition group.

If the service returns an enum value that is not available in the current SDK version, state will return CloudHsmObjectState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the high-availability partition group.

See Also:

CloudHsmObjectState

stateAsString

public final String stateAsString()

The state of the high-availability partition group.

If the service returns an enum value that is not available in the current SDK version, state will return CloudHsmObjectState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the high-availability partition group.

See Also:

CloudHsmObjectState

toBuilder

public DescribeHapgResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHapgResponse.Builder,DescribeHapgResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeHapgResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeHapgResponse.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