Package software.amazon.awssdk.services.cloudtrail.model

Class GetQueryResultsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse

software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetQueryResultsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetQueryResultsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage()	The error message returned if a query failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueryResultRows()	For responses, this returns true if the service returned a value for the QueryResultRows property.
String	nextToken()	A token you can use to get the next page of query results.
List<List<Map<String,String>>>	queryResultRows()	Contains the individual event results of the query.
QueryStatistics	queryStatistics()	Shows the count of query results.
QueryStatus	queryStatus()	The status of the query.
String	queryStatusAsString()	The status of the query.
List<SdkField<?>>	sdkFields()
static Class<? extends GetQueryResultsResponse.Builder>	serializableBuilderClass()
GetQueryResultsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse

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

queryStatus

public final QueryStatus queryStatus()

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

If the service returns an enum value that is not available in the current SDK version, queryStatus will return QueryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryStatusAsString().

Returns:

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

See Also:

QueryStatus

queryStatusAsString

public final String queryStatusAsString()

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

If the service returns an enum value that is not available in the current SDK version, queryStatus will return QueryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryStatusAsString().

Returns:

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

See Also:

QueryStatus

queryStatistics

public final QueryStatistics queryStatistics()

Shows the count of query results.

Returns:

Shows the count of query results.

hasQueryResultRows

public final boolean hasQueryResultRows()

For responses, this returns true if the service returned a value for the QueryResultRows 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.

queryResultRows

public final List<List<Map<String,String>>> queryResultRows()

Contains the individual event results of the query.

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 hasQueryResultRows() method.

Returns:

Contains the individual event results of the query.

nextToken

public final String nextToken()

A token you can use to get the next page of query results.

Returns:

A token you can use to get the next page of query results.

errorMessage

public final String errorMessage()

The error message returned if a query failed.

Returns:

The error message returned if a query failed.

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