Interface ExecuteScheduledQueryRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ExecuteScheduledQueryRequest.Builder,ExecuteScheduledQueryRequest>, SdkBuilder<ExecuteScheduledQueryRequest.Builder,ExecuteScheduledQueryRequest>, SdkPojo, SdkRequest.Builder, TimestreamQueryRequest.Builder

Enclosing class:

ExecuteScheduledQueryRequest

@Mutable
@NotThreadSafe
public static interface ExecuteScheduledQueryRequest.Builder
extends TimestreamQueryRequest.Builder, SdkPojo, CopyableBuilder<ExecuteScheduledQueryRequest.Builder,ExecuteScheduledQueryRequest>

Method Summary

Modifier and Type	Method	Description
ExecuteScheduledQueryRequest.Builder	clientToken(String clientToken)	Not used.
ExecuteScheduledQueryRequest.Builder	invocationTime(Instant invocationTime)	The timestamp in UTC.
ExecuteScheduledQueryRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ExecuteScheduledQueryRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default ExecuteScheduledQueryRequest.Builder	queryInsights(Consumer<ScheduledQueryInsights.Builder> queryInsights)	Encapsulates settings for enabling QueryInsights.
ExecuteScheduledQueryRequest.Builder	queryInsights(ScheduledQueryInsights queryInsights)	Encapsulates settings for enabling QueryInsights.
ExecuteScheduledQueryRequest.Builder	scheduledQueryArn(String scheduledQueryArn)	ARN of the scheduled query.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryRequest.Builder

build

Method Details

scheduledQueryArn

ExecuteScheduledQueryRequest.Builder scheduledQueryArn(String scheduledQueryArn)

ARN of the scheduled query.

Parameters:

scheduledQueryArn - ARN of the scheduled query.

Returns:

Returns a reference to this object so that method calls can be chained together.

invocationTime

ExecuteScheduledQueryRequest.Builder invocationTime(Instant invocationTime)

The timestamp in UTC. Query will be run as if it was invoked at this timestamp.

Parameters:

invocationTime - The timestamp in UTC. Query will be run as if it was invoked at this timestamp.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

ExecuteScheduledQueryRequest.Builder clientToken(String clientToken)

Not used.

Parameters:

clientToken - Not used.

Returns:

Returns a reference to this object so that method calls can be chained together.

queryInsights

ExecuteScheduledQueryRequest.Builder queryInsights(ScheduledQueryInsights queryInsights)

Encapsulates settings for enabling QueryInsights.

Enabling QueryInsights returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use QueryInsights to tune your query performance and cost.

Parameters:

queryInsights - Encapsulates settings for enabling QueryInsights.

Enabling QueryInsights returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use QueryInsights to tune your query performance and cost.

Returns:

Returns a reference to this object so that method calls can be chained together.

queryInsights

default ExecuteScheduledQueryRequest.Builder queryInsights(Consumer<ScheduledQueryInsights.Builder> queryInsights)

Encapsulates settings for enabling QueryInsights.

Enabling QueryInsights returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use QueryInsights to tune your query performance and cost.

This is a convenience method that creates an instance of the ScheduledQueryInsights.Builder avoiding the need to create one manually via ScheduledQueryInsights.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryInsights(ScheduledQueryInsights).

Parameters:

queryInsights - a consumer that will call methods on ScheduledQueryInsights.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• queryInsights(ScheduledQueryInsights)

overrideConfiguration

ExecuteScheduledQueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ExecuteScheduledQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.