Class ErrorDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ErrorDetails.Builder,
ErrorDetails>
Contains the details of an IoT SiteWise error.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ErrorDetails.Builder
builder()
final ErrorCode
code()
The error code.final String
The error code.final List
<DetailedError> details()
A list of detailed errors.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 Details property.final int
hashCode()
final String
message()
The error message.static Class
<? extends ErrorDetails.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
-
code
The error code.
If the service returns an enum value that is not available in the current SDK version,
code
will returnErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcodeAsString()
.- Returns:
- The error code.
- See Also:
-
codeAsString
The error code.
If the service returns an enum value that is not available in the current SDK version,
code
will returnErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcodeAsString()
.- Returns:
- The error code.
- See Also:
-
message
The error message.
- Returns:
- The error message.
-
hasDetails
public final boolean hasDetails()For responses, this returns true if the service returned a value for the Details 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. -
details
A list of detailed errors.
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
hasDetails()
method.- Returns:
- A list of detailed errors.
-
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<ErrorDetails.Builder,
ErrorDetails> - 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
-