software.amazon.awssdk.services.resourcegroups.model

Class QueryError

java.lang.Object

software.amazon.awssdk.services.resourcegroups.model.QueryError

All Implemented Interfaces:

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

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

A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFront stack-based queries. The error occurs if the CloudFront stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that Resource Groups could not complete the operation, but the resulting group might have no member resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryError.Builder

Method Summary

Modifier and Type	Method and Description
static QueryError.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
QueryErrorCode	errorCode() Specifies the error code that was raised.
String	errorCodeAsString() Specifies the error code that was raised.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message() A message that explains the ErrorCode value.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryError.Builder>	serializableBuilderClass()
QueryError.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

errorCode

public final QueryErrorCode errorCode()

Specifies the error code that was raised.

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

Returns:

Specifies the error code that was raised.

See Also:

QueryErrorCode

errorCodeAsString

public final String errorCodeAsString()

Specifies the error code that was raised.

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

Returns:

Specifies the error code that was raised.

See Also:

QueryErrorCode

message

public final String message()

A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED.

Returns:

A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED.

toBuilder

public QueryError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryError.Builder,QueryError>

builder

public static QueryError.Builder builder()

serializableBuilderClass

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