Class AnalysisError
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.AnalysisError
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AnalysisError.Builder,AnalysisError>
@Generated("software.amazon.awssdk:codegen") public final class AnalysisError extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisError.Builder,AnalysisError>
Analysis error.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AnalysisError.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AnalysisError.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()
The message associated with the analysis error.List<SdkField<?>>
sdkFields()
static Class<? extends AnalysisError.Builder>
serializableBuilderClass()
AnalysisError.Builder
toBuilder()
String
toString()
Returns a string representation of this object.AnalysisErrorType
type()
The type of the analysis error.String
typeAsString()
The type of the analysis error.List<Entity>
violatedEntities()
Lists the violated entities that caused the analysis 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 AnalysisErrorType type()
The type of the analysis error.
If the service returns an enum value that is not available in the current SDK version,
type
will returnAnalysisErrorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the analysis error.
- See Also:
AnalysisErrorType
-
typeAsString
public final String typeAsString()
The type of the analysis error.
If the service returns an enum value that is not available in the current SDK version,
type
will returnAnalysisErrorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the analysis error.
- See Also:
AnalysisErrorType
-
message
public final String message()
The message associated with the analysis error.
- Returns:
- The message associated with the analysis error.
-
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 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.
-
violatedEntities
public final List<Entity> violatedEntities()
Lists the violated entities that caused the analysis 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:
- Lists the violated entities that caused the analysis error
-
toBuilder
public AnalysisError.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AnalysisError.Builder,AnalysisError>
-
builder
public static AnalysisError.Builder builder()
-
serializableBuilderClass
public static Class<? extends AnalysisError.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-