software.amazon.awssdk.services.iotsitewise.model

Class ErrorDetails

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.ErrorDetails

All Implemented Interfaces:

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

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

Contains the details of an IoT SiteWise error.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ErrorDetails.Builder

Method Summary

Modifier and Type	Method and Description
static ErrorDetails.Builder	builder()
ErrorCode	code() The error code.
String	codeAsString() The error code.
List<DetailedError>	details() A list of detailed errors.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetails() For responses, this returns true if the service returned a value for the Details property.
int	hashCode()
String	message() The error message.
List<SdkField<?>>	sdkFields()
static Class<? extends ErrorDetails.Builder>	serializableBuilderClass()
ErrorDetails.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

code

public final ErrorCode code()

The error code.

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

Returns:

The error code.

See Also:

ErrorCode

codeAsString

public final String codeAsString()

The error code.

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

Returns:

The error code.

See Also:

ErrorCode

message

public final String 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 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.

details

public final List<DetailedError> 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

public ErrorDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ErrorDetails.Builder,ErrorDetails>

builder

public static ErrorDetails.Builder builder()

serializableBuilderClass

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