Class QuerySummary

java.lang.Object
software.amazon.awssdk.services.artifact.model.QuerySummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QuerySummary.Builder,QuerySummary>
@Generated("software.amazon.awssdk:codegen") public final class QuerySummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QuerySummary.Builder,QuerySummary>

Summary information about a single query within a compliance inquiry.

See Also:

  • Method Details

    • queryIdentifier

      public final Integer queryIdentifier()

      Sequential identifier of the query within the inquiry.

      Returns:
      Sequential identifier of the query within the inquiry.

    • query

      public final String query()

      The actual query text.

      Returns:
      The actual query text.

    • response

      public final String response()

      Generated response to the query.

      Returns:
      Generated response to the query.

    • reviewType

      public final ReviewType reviewType()

      Type of review for the response.

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

      Returns:
      Type of review for the response.
      See Also:

    • reviewTypeAsString

      public final String reviewTypeAsString()

      Type of review for the response.

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

      Returns:
      Type of review for the response.
      See Also:

    • hasCitations

      public final boolean hasCitations()
      For responses, this returns true if the service returned a value for the Citations 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.

    • citations

      public final List<Citation> citations()

      Supporting citations for the response.

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

      Returns:
      Supporting citations for the response.

    • status

      public final QueryStatus status()

      Current processing status of the query.

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

      Returns:
      Current processing status of the query.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current processing status of the query.

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

      Returns:
      Current processing status of the query.
      See Also:

    • statusMessage

      public final QueryStatusMessage statusMessage()

      Descriptive status message.

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

      Returns:
      Descriptive status message.
      See Also:

    • statusMessageAsString

      public final String statusMessageAsString()

      Descriptive status message.

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

      Returns:
      Descriptive status message.
      See Also:

    • createdAt

      public final Instant createdAt()

      Timestamp when the query was created.

      Returns:
      Timestamp when the query was created.

    • hasUpdatedResponseVersions

      public final boolean hasUpdatedResponseVersions()
      For responses, this returns true if the service returned a value for the UpdatedResponseVersions 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.

    • updatedResponseVersions

      public final List<ResponseVersion> updatedResponseVersions()

      Ordered list of response version history entries, oldest first.

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

      Returns:
      Ordered list of response version history entries, oldest first.

    • toBuilder

      public QuerySummary.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<QuerySummary.Builder,QuerySummary>
      Returns:
      a builder for type T

    • builder

      public static QuerySummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.