Class ListQueriesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListQueriesRequest.Builder,
ListQueriesRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ListQueriesRequest.Builder
builder()
final Instant
endTime()
Use withStartTime
to bound aListQueries
request, and limit its results to only those queries run within a specified time period.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of queries to show on a page.final String
A token you can use to get the next page of results.final QueryStatus
The status of queries that you want to return in results.final String
The status of queries that you want to return in results.static Class
<? extends ListQueriesRequest.Builder> final Instant
Use withEndTime
to bound aListQueries
request, and limit its results to only those queries run within a specified time period.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.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
eventDataStore
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
- Returns:
- The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
-
nextToken
A token you can use to get the next page of results.
- Returns:
- A token you can use to get the next page of results.
-
maxResults
The maximum number of queries to show on a page.
- Returns:
- The maximum number of queries to show on a page.
-
startTime
Use with
EndTime
to bound aListQueries
request, and limit its results to only those queries run within a specified time period.- Returns:
- Use with
EndTime
to bound aListQueries
request, and limit its results to only those queries run within a specified time period.
-
endTime
Use with
StartTime
to bound aListQueries
request, and limit its results to only those queries run within a specified time period.- Returns:
- Use with
StartTime
to bound aListQueries
request, and limit its results to only those queries run within a specified time period.
-
queryStatus
The status of queries that you want to return in results. Valid 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 queries that you want to return in results. Valid values for
QueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
. - See Also:
-
queryStatusAsString
The status of queries that you want to return in results. Valid 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 queries that you want to return in results. Valid values for
QueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
. - 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<ListQueriesRequest.Builder,
ListQueriesRequest> - Specified by:
toBuilder
in classCloudTrailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-