Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<QueryError.Builder,QueryError>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.