Class QueryStatistics

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

Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

If the query involved log groups that have field index policies, the estimated number of skipped log events and the total bytes of those skipped log events are included. Using field indexes to skip log events in queries reduces scan volume and improves performance. For more information, see Create field indexes to improve query performance and reduce scan volume.

See Also:

  • Method Details

    • recordsMatched

      public final Double recordsMatched()

      The number of log events that matched the query string.

      Returns:
      The number of log events that matched the query string.

    • recordsScanned

      public final Double recordsScanned()

      The total number of log events scanned during the query.

      Returns:
      The total number of log events scanned during the query.

    • estimatedRecordsSkipped

      public final Double estimatedRecordsSkipped()

      An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

      Returns:
      An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

    • bytesScanned

      public final Double bytesScanned()

      The total number of bytes in the log events scanned during the query.

      Returns:
      The total number of bytes in the log events scanned during the query.

    • estimatedBytesSkipped

      public final Double estimatedBytesSkipped()

      An estimate of the number of bytes in the log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

      Returns:
      An estimate of the number of bytes in the log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

    • logGroupsScanned

      public final Double logGroupsScanned()

      The number of log groups that were scanned by this query.

      Returns:
      The number of log groups that were scanned by this query.

    • toBuilder

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

    • builder

      public static QueryStatistics.Builder builder()

    • serializableBuilderClass

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