QueryRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.timestreamquery.model.QueryRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class QueryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

QueryRequest()

Constructors
Constructor and Description
`QueryRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` Unique, case-sensitive string of up to 64 ASCII characters specified when a `Query` request is made.
`Integer`	`getMaxRows()` The total number of rows to be returned in the `Query` output.
`String`	`getNextToken()` A pagination token used to return a set of results.
`String`	`getQueryString()` The query to be run by Timestream.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` Unique, case-sensitive string of up to 64 ASCII characters specified when a `Query` request is made.
`void`	`setMaxRows(Integer maxRows)` The total number of rows to be returned in the `Query` output.
`void`	`setNextToken(String nextToken)` A pagination token used to return a set of results.
`void`	`setQueryString(String queryString)` The query to be run by Timestream.
`String`	`toString()` Returns a string representation of this object.
`QueryRequest`	`withClientToken(String clientToken)` Unique, case-sensitive string of up to 64 ASCII characters specified when a `Query` request is made.
`QueryRequest`	`withMaxRows(Integer maxRows)` The total number of rows to be returned in the `Query` output.
`QueryRequest`	`withNextToken(String nextToken)` A pagination token used to return a set of results.
`QueryRequest`	`withQueryString(String queryString)` The query to be run by Timestream.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - QueryRequest
```
public QueryRequest()
```
- Method Detail
  - setQueryString
```
public void setQueryString(String queryString)
```
    The query to be run by Timestream.
    
    Parameters:
    
    queryString - The query to be run by Timestream.
  - getQueryString
```
public String getQueryString()
```
    The query to be run by Timestream.
    
    Returns:
    
    The query to be run by Timestream.
  - withQueryString
```
public QueryRequest withQueryString(String queryString)
```
    The query to be run by Timestream.
    
    Parameters:
    
    queryString - The query to be run by Timestream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
    - If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    - If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query 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.
    Parameters:
    clientToken - Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
    
    If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    
    If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query 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.
  - getClientToken
```
public String getClientToken()
```
    Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
    - If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    - If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query 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 a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
    
    If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    
    If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query 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.
  - withClientToken
```
public QueryRequest withClientToken(String clientToken)
```
    Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
    - If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    - If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query 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.
    Parameters:
    clientToken - Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
    
    If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    
    If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query 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 recent nextToken.
    - Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA 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 until null is returned, at which point a new NextToken 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.
    Parameters:
    nextToken - A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query 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 recent nextToken.
    
    Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA 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 until null is returned, at which point a new NextToken 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.
  - getNextToken
```
public String getNextToken()
```
    A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query 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 recent nextToken.
    - Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA 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 until null is returned, at which point a new NextToken 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 using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query 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 recent nextToken.
    
    Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA 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 until null is returned, at which point a new NextToken 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.
  - withNextToken
```
public QueryRequest withNextToken(String nextToken)
```
    A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query 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 recent nextToken.
    - Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA 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 until null is returned, at which point a new NextToken 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.
    Parameters:
    nextToken - A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query 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 recent nextToken.
    
    Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA 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 until null is returned, at which point a new NextToken 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRows
```
public void setMaxRows(Integer maxRows)
```
    The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows 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 a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken 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.
    Parameters:
    maxRows - The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows 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 a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken 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.
  - getMaxRows
```
public Integer getMaxRows()
```
    The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows 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 a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken 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 of Query with a MaxRows 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 a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken 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.
  - withMaxRows
```
public QueryRequest withMaxRows(Integer maxRows)
```
    The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows 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 a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken 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.
    Parameters:
    maxRows - The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows 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 a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public QueryRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.792

Class QueryRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

QueryRequest

Method Detail

setQueryString

getQueryString

withQueryString

setClientToken

getClientToken

withClientToken

setNextToken

getNextToken

withNextToken

setMaxRows

getMaxRows

withMaxRows

toString

equals

hashCode

clone