Class StorageGatewayError
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StorageGatewayError.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorCode
Additional information about the error.final String
Additional information about the error.Human-readable text that provides detail about the error that occurred.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ErrorDetails property.final int
hashCode()
static Class
<? extends StorageGatewayError.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
errorCode
Additional information about the error.
If the service returns an enum value that is not available in the current SDK version,
errorCode
will returnErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorCodeAsString()
.- Returns:
- Additional information about the error.
- See Also:
-
errorCodeAsString
Additional information about the error.
If the service returns an enum value that is not available in the current SDK version,
errorCode
will returnErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorCodeAsString()
.- Returns:
- Additional information about the error.
- See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<StorageGatewayError.Builder,
StorageGatewayError> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-