software.amazon.awssdk.services.timestreamquery.model

Class QueryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryRequest

software.amazon.awssdk.services.timestreamquery.model.QueryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryRequest
extends TimestreamQueryRequest
implements ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static QueryRequest.Builder	builder()
String	clientToken() Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxRows() The total number of rows to return in the output.
String	nextToken() A pagination token passed to get a set of results.
String	queryString() The query to be executed by Timestream.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryRequest.Builder>	serializableBuilderClass()
QueryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

queryString

public final String queryString()

The query to be executed by Timestream.

Returns:

The query to be executed by Timestream.

clientToken

public final String clientToken()

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

• If you submit a request with the same client token outside the 5-minute idepotency window.

• If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Returns:

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

• If you submit a request with the same client token outside the 5-minute idepotency window.

• If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

nextToken

public final String nextToken()

A pagination token passed to get a set of results.

Returns:

A pagination token passed to get a set of results.

maxRows

public final Integer maxRows()

The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.

Returns:

The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.

toBuilder

public QueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

Specified by:

toBuilder in class TimestreamQueryRequest

builder

public static QueryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends QueryRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo