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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceQueryStatistics.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static QueryStatistics.Builderbuilder()DoublebytesScanned()The total number of bytes in the log events scanned during the query.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)DoubleestimatedBytesSkipped()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.DoubleestimatedRecordsSkipped()An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()DoublelogGroupsScanned()The number of log groups that were scanned by this query.DoublerecordsMatched()The number of log events that matched the query string.DoublerecordsScanned()The total number of log events scanned during the query.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends QueryStatistics.Builder>serializableBuilderClass()QueryStatistics.BuildertoBuilder()StringtoString()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
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<QueryStatistics.Builder,QueryStatistics>
-
builder
public static QueryStatistics.Builder builder()
-
serializableBuilderClass
public static Class<? extends QueryStatistics.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-