@Generated(value="software.amazon.awssdk:codegen") public final class GetQueryResultsResponse extends CloudWatchLogsResponse implements ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetQueryResultsResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetQueryResultsResponse.Builder |
builder() |
String |
encryptionKey()
If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays
the ARN of the key that's used to encrypt the query results when StartQuery
stores them.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasResults()
For responses, this returns true if the service returned a value for the Results property.
|
List<List<ResultField>> |
results()
The log events that matched the query criteria during the most recent time it ran.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetQueryResultsResponse.Builder> |
serializableBuilderClass() |
QueryStatistics |
statistics()
Includes 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 scanned log events.
|
QueryStatus |
status()
The status of the most recent running of the query.
|
String |
statusAsString()
The status of the most recent running of the query.
|
GetQueryResultsResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasResults()
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.public final List<List<ResultField>> results()
The log events that matched the query criteria during the most recent time it ran.
The results value is an array of arrays. Each log event is one object in the top-level array. Each
of these log event objects is an array of field/value pairs.
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 hasResults() method.
The results value is an array of arrays. Each log event is one object in the top-level
array. Each of these log event objects is an array of field/value pairs.
public final QueryStatistics statistics()
Includes 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 scanned log events. These values reflect the full raw results of the query.
public final QueryStatus status()
The status of the most recent running of the query. Possible values are Cancelled,
Complete, Failed, Running, Scheduled, Timeout,
and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
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().
Cancelled,
Complete, Failed, Running, Scheduled,
Timeout, and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
QueryStatuspublic final String statusAsString()
The status of the most recent running of the query. Possible values are Cancelled,
Complete, Failed, Running, Scheduled, Timeout,
and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
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().
Cancelled,
Complete, Failed, Running, Scheduled,
Timeout, and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
QueryStatuspublic final String encryptionKey()
If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.
public GetQueryResultsResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>toBuilder in class AwsResponsepublic static GetQueryResultsResponse.Builder builder()
public static Class<? extends GetQueryResultsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.