Package software.amazon.awssdk.services.storagegateway.model

Class StorageGatewayError

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.StorageGatewayError

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StorageGatewayError.Builder,StorageGatewayError>

@Generated("software.amazon.awssdk:codegen")
public final class StorageGatewayError
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StorageGatewayError.Builder,StorageGatewayError>

Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StorageGatewayError.Builder

Method Summary

Modifier and Type	Method	Description
static StorageGatewayError.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCode	errorCode()	Additional information about the error.
String	errorCodeAsString()	Additional information about the error.
Map<String,String>	errorDetails()	Human-readable text that provides detail about the error that occurred.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrorDetails()	For responses, this returns true if the service returned a value for the ErrorDetails property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StorageGatewayError.Builder>	serializableBuilderClass()
StorageGatewayError.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

errorCode

public final ErrorCode errorCode()

Additional information about the error.

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

Returns:

Additional information about the error.

See Also:

ErrorCode

errorCodeAsString

public final String errorCodeAsString()

Additional information about the error.

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

Returns:

Additional information about the error.

See Also:

ErrorCode

hasErrorDetails

public final boolean hasErrorDetails()

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

errorDetails

public final Map<String,String> errorDetails()

Human-readable text that provides detail about the error that occurred.

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

Returns:

Human-readable text that provides detail about the error that occurred.

toBuilder

public StorageGatewayError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StorageGatewayError.Builder,StorageGatewayError>

builder

public static StorageGatewayError.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo