software.amazon.awssdk.services.quicksight.model

Class TemplateError

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TemplateError

All Implemented Interfaces:

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

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

List of errors that occurred when the template version creation failed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TemplateError.Builder

Method Summary

Modifier and Type	Method and Description
static TemplateError.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasViolatedEntities() For responses, this returns true if the service returned a value for the ViolatedEntities property.
String	message() Description of the error type.
List<SdkField<?>>	sdkFields()
static Class<? extends TemplateError.Builder>	serializableBuilderClass()
TemplateError.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TemplateErrorType	type() Type of error.
String	typeAsString() Type of error.
List<Entity>	violatedEntities() An error path that shows which entities caused the template error.

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

type

public final TemplateErrorType type()

Type of error.

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

Returns:

Type of error.

See Also:

TemplateErrorType

typeAsString

public final String typeAsString()

Type of error.

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

Returns:

Type of error.

See Also:

TemplateErrorType

message

public final String message()

Description of the error type.

Returns:

Description of the error type.

hasViolatedEntities

public final boolean hasViolatedEntities()

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

violatedEntities

public final List<Entity> violatedEntities()

An error path that shows which entities caused the template error.

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

Returns:

An error path that shows which entities caused the template error.

toBuilder

public TemplateError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TemplateError.Builder,TemplateError>

builder

public static TemplateError.Builder builder()

serializableBuilderClass

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