Class QueryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<QueryRequest.Builder,
QueryRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic QueryRequest.Builder
builder()
final String
Unique, case-sensitive string of up to 64 ASCII characters specified when aQuery
request is made.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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
maxRows()
The total number of rows to be returned in theQuery
output.final String
A pagination token used to return a set of results.final String
The query to be run by Timestream.static Class
<? extends QueryRequest.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.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
queryString
The query to be run by Timestream.
- Returns:
- The query to be run by Timestream.
-
clientToken
Unique, case-sensitive string of up to 64 ASCII characters specified when a
Query
request is made. Providing aClientToken
makes the call toQuery
idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identicalQuery
requests has the same effect as making a single request. When usingClientToken
in a query, note the following:-
If the Query API is instantiated without a
ClientToken
, the Query SDK generates aClientToken
on your behalf. -
If the
Query
invocation only contains theClientToken
but does not include aNextToken
, that invocation ofQuery
is assumed to be a new query run. -
If the invocation contains
NextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned. -
After 4 hours, any request with the same
ClientToken
is treated as a new request.
- Returns:
- Unique, case-sensitive string of up to 64 ASCII characters specified when a
Query
request is made. Providing aClientToken
makes the call toQuery
idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identicalQuery
requests has the same effect as making a single request. When usingClientToken
in a query, note the following:-
If the Query API is instantiated without a
ClientToken
, the Query SDK generates aClientToken
on your behalf. -
If the
Query
invocation only contains theClientToken
but does not include aNextToken
, that invocation ofQuery
is assumed to be a new query run. -
If the invocation contains
NextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned. -
After 4 hours, any request with the same
ClientToken
is treated as a new request.
-
-
-
nextToken
A pagination token used to return a set of results. When the
Query
API is invoked usingNextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call toQuery
, and a result set is returned. However, if theQuery
invocation only contains theClientToken
, that invocation ofQuery
is assumed to be a new query run.Note the following when using NextToken in a query:
-
A pagination token can be used for up to five
Query
invocations, OR for a duration of up to 1 hour – whichever comes first. -
Using the same
NextToken
will return the same set of records. To keep paginating through the result set, you must to use the most recentnextToken
. -
Suppose a
Query
invocation returns twoNextToken
values,TokenA
andTokenB
. IfTokenB
is used in a subsequentQuery
invocation, thenTokenA
is invalidated and cannot be reused. -
To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
-
The latest
NextToken
should be used to paginate untilnull
is returned, at which point a newNextToken
should be used. -
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token
error.
- Returns:
- A pagination token used to return a set of results. When the
Query
API is invoked usingNextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call toQuery
, and a result set is returned. However, if theQuery
invocation only contains theClientToken
, that invocation ofQuery
is assumed to be a new query run.Note the following when using NextToken in a query:
-
A pagination token can be used for up to five
Query
invocations, OR for a duration of up to 1 hour – whichever comes first. -
Using the same
NextToken
will return the same set of records. To keep paginating through the result set, you must to use the most recentnextToken
. -
Suppose a
Query
invocation returns twoNextToken
values,TokenA
andTokenB
. IfTokenB
is used in a subsequentQuery
invocation, thenTokenA
is invalidated and cannot be reused. -
To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
-
The latest
NextToken
should be used to paginate untilnull
is returned, at which point a newNextToken
should be used. -
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token
error.
-
-
-
maxRows
The total number of rows to be returned in the
Query
output. The initial run ofQuery
with aMaxRows
value specified will return the result set of the query in two cases:-
The size of the result is less than
1MB
. -
The number of rows in the result set is less than the value of
maxRows
.
Otherwise, the initial invocation of
Query
only returns aNextToken
, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide theNextToken
value in the subsequent command.If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If
MaxRows
is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit.- Returns:
- The total number of rows to be returned in the
Query
output. The initial run ofQuery
with aMaxRows
value specified will return the result set of the query in two cases:-
The size of the result is less than
1MB
. -
The number of rows in the result set is less than the value of
maxRows
.
Otherwise, the initial invocation of
Query
only returns aNextToken
, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide theNextToken
value in the subsequent command.If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If
MaxRows
is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit. -
-
-
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<QueryRequest.Builder,
QueryRequest> - Specified by:
toBuilder
in classTimestreamQueryRequest
- 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
-