Class DescribeQueryResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeQueryResponse.Builder,
DescribeQueryResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The URI for the S3 bucket where CloudTrail delivered query results, if applicable.final DeliveryStatus
The delivery status.final String
The delivery status.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The error message returned if a query failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
queryId()
The ID of the query.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.final QueryStatus
The status of a query.final String
The status of a query.final String
The SQL code of a query.static Class
<? extends DescribeQueryResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
queryId
The ID of the query.
- Returns:
- The ID of the query.
-
queryString
The SQL code of a query.
- Returns:
- The SQL code of a query.
-
queryStatus
The status of a query. Values for
QueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
If the service returns an enum value that is not available in the current SDK version,
queryStatus
will returnQueryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqueryStatusAsString()
.- Returns:
- The status of a query. Values for
QueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
- See Also:
-
queryStatusAsString
The status of a query. Values for
QueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
If the service returns an enum value that is not available in the current SDK version,
queryStatus
will returnQueryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqueryStatusAsString()
.- Returns:
- The status of a query. Values for
QueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
- See Also:
-
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
The error message returned if a query failed.
- Returns:
- The error message returned if a query failed.
-
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
The delivery status.
If the service returns an enum value that is not available in the current SDK version,
deliveryStatus
will returnDeliveryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStatusAsString()
.- Returns:
- The delivery status.
- See Also:
-
deliveryStatusAsString
The delivery status.
If the service returns an enum value that is not available in the current SDK version,
deliveryStatus
will returnDeliveryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStatusAsString()
.- Returns:
- The delivery status.
- See Also:
-
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 interfaceToCopyableBuilder<DescribeQueryResponse.Builder,
DescribeQueryResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-