software.amazon.awssdk.services.cloudwatchlogs.model

Class GetQueryResultsResponse

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(value="software.amazon.awssdk:codegen")
public final class GetQueryResultsResponse
extends CloudWatchLogsResponse
implements ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetQueryResultsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetQueryResultsResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
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 log events that were scanned.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

results

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

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 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 log events that were scanned.

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 log events that were scanned.

status

public QueryStatus status()

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

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, and Unknown.

See Also:

QueryStatus

statusAsString

public String statusAsString()

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

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, and Unknown.

See Also:

QueryStatus

toBuilder

public GetQueryResultsResponse.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<GetQueryResultsResponse.Builder,GetQueryResultsResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetQueryResultsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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