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

Class DescribeQueryResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeQueryResponse.Builder,DescribeQueryResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeQueryResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeQueryResponse.Builder	builder()
String	deliveryS3Uri()	The URI for the S3 bucket where CloudTrail delivered query results, if applicable.
DeliveryStatus	deliveryStatus()	The delivery status.
String	deliveryStatusAsString()	The delivery status.
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()
String	queryId()	The ID of the query.
QueryStatisticsForDescribeQuery	queryStatistics()	Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
QueryStatus	queryStatus()	The status of a query.
String	queryStatusAsString()	The status of a query.
String	queryString()	The SQL code of a query.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeQueryResponse.Builder>	serializableBuilderClass()
DescribeQueryResponse.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

queryId

public final String queryId()

The ID of the query.

Returns:

The ID of the query.

queryString

public final String queryString()

The SQL code of a query.

Returns:

The SQL code of a query.

queryStatus

public final QueryStatus queryStatus()

The status of a query. Values for QueryStatus 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 a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

See Also:

QueryStatus

queryStatusAsString

public final String queryStatusAsString()

The status of a query. Values for QueryStatus 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 a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

See Also:

QueryStatus

queryStatistics

public final QueryStatisticsForDescribeQuery queryStatistics()

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

Returns:

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

errorMessage

public final String errorMessage()

The error message returned if a query failed.

Returns:

The error message returned if a query failed.

deliveryS3Uri

public final String deliveryS3Uri()

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

Returns:

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

deliveryStatus

public final DeliveryStatus deliveryStatus()

The delivery status.

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

Returns:

The delivery status.

See Also:

DeliveryStatus

deliveryStatusAsString

public final String deliveryStatusAsString()

The delivery status.

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

Returns:

The delivery status.

See Also:

DeliveryStatus

toBuilder

public DescribeQueryResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeQueryResponse.Builder,DescribeQueryResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeQueryResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeQueryResponse.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