java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsResponse
    - - software.amazon.awssdk.services.cloudwatchlogs.model.GetQueryResultsResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetQueryResultsResponse
extends CloudWatchLogsResponse
implements ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetQueryResultsResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`QueryLanguage`	`queryLanguage()`	The query language used for this query.
`String`	`queryLanguageAsString()`	The query language used for this query.
`List<List<ResultField>>`	`results()`	The log events that matched the query criteria during the most recent time it ran.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.

Methods inherited from class software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - queryLanguage
```
public final QueryLanguage queryLanguage()
```
    The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().
    
    Returns:
    
    The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    See Also:
    
    QueryLanguage
  - queryLanguageAsString
```
public final String queryLanguageAsString()
```
    The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().
    
    Returns:
    
    The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    See Also:
    
    QueryLanguage
  - hasResults
```
public final boolean hasResults()
```
    For responses, this returns true if the service returned a value for the Results 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.
  - results
```
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.
    
    Returns:
    
    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.
  - statistics
```
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.
    
    Returns:
    
    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.
  - status
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    QueryStatus
  - statusAsString
```
public 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().
    
    Returns:
    
    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.
    
    See Also:
    
    QueryStatus
  - encryptionKey
```
public 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.
    
    Returns:
    
    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.
  - toBuilder
```
public GetQueryResultsResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetQueryResultsResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetQueryResultsResponse.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetQueryResultsResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

queryLanguage

queryLanguageAsString

hasResults

results

statistics

status

statusAsString

encryptionKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField