Class DescribeQueryResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse
software.amazon.awssdk.services.cloudtrail.model.DescribeQueryResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeQueryResponse.Builder,DescribeQueryResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeQueryResponse extends CloudTrailResponse implements ToCopyableBuilder<DescribeQueryResponse.Builder,DescribeQueryResponse>

  • Method Details

    • queryId

      public final String queryId()

      The ID of the query.

      Returns:
      The ID of the query.

    • queryString

      public final String queryString()

      The SQL code of a query.

      Returns:
      The SQL code of a query.

    • queryStatus

      public final QueryStatus queryStatus()

      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

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

      Returns:
      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED
      See Also:

    • queryStatusAsString

      public final String queryStatusAsString()

      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

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

      Returns:
      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED
      See Also:

    • queryStatistics

      public final QueryStatisticsForDescribeQuery queryStatistics()

      Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

      Returns:
      Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

    • errorMessage

      public final String errorMessage()

      The error message returned if a query failed.

      Returns:
      The error message returned if a query failed.

    • deliveryS3Uri

      public final String deliveryS3Uri()

      The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

      Returns:
      The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

    • deliveryStatus

      public final DeliveryStatus deliveryStatus()

      The delivery status.

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

      Returns:
      The delivery status.
      See Also:

    • deliveryStatusAsString

      public final String deliveryStatusAsString()

      The delivery status.

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

      Returns:
      The delivery status.
      See Also:

    • toBuilder

      public DescribeQueryResponse.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<DescribeQueryResponse.Builder,DescribeQueryResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeQueryResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeQueryResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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