Interface CreateScheduledQueryRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateScheduledQueryRequest.Builder,
,CreateScheduledQueryRequest> SdkBuilder<CreateScheduledQueryRequest.Builder,
,CreateScheduledQueryRequest> SdkPojo
,SdkRequest.Builder
,TimestreamQueryRequest.Builder
- Enclosing class:
CreateScheduledQueryRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.errorReportConfiguration
(Consumer<ErrorReportConfiguration.Builder> errorReportConfiguration) Configuration for error reporting.errorReportConfiguration
(ErrorReportConfiguration errorReportConfiguration) Configuration for error reporting.The Amazon KMS key used to encrypt the scheduled query resource, at-rest.Name of the scheduled query.notificationConfiguration
(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Notification configuration for the scheduled query.notificationConfiguration
(NotificationConfiguration notificationConfiguration) Notification configuration for the scheduled query.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.queryString
(String queryString) The query string to run.scheduleConfiguration
(Consumer<ScheduleConfiguration.Builder> scheduleConfiguration) The schedule configuration for the query.scheduleConfiguration
(ScheduleConfiguration scheduleConfiguration) The schedule configuration for the query.scheduledQueryExecutionRoleArn
(String scheduledQueryExecutionRoleArn) The ARN for the IAM role that Timestream will assume when running the scheduled query.tags
(Collection<Tag> tags) A list of key-value pairs to label the scheduled query.tags
(Consumer<Tag.Builder>... tags) A list of key-value pairs to label the scheduled query.A list of key-value pairs to label the scheduled query.targetConfiguration
(Consumer<TargetConfiguration.Builder> targetConfiguration) Configuration used for writing the result of a query.targetConfiguration
(TargetConfiguration targetConfiguration) Configuration used for writing the result of a 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, sdkFields
Methods inherited from interface software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryRequest.Builder
build
-
Method Details
-
name
Name of the scheduled query.
- Parameters:
name
- Name of the scheduled query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queryString
The query string to run. Parameter names can be specified in the query string
@
character followed by an identifier. The named Parameter@scheduled_runtime
is reserved and can be used in the query to get the time at which the query is scheduled to run.The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of
@scheduled_runtime
paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the@scheduled_runtime
parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.- Parameters:
queryString
- The query string to run. Parameter names can be specified in the query string@
character followed by an identifier. The named Parameter@scheduled_runtime
is reserved and can be used in the query to get the time at which the query is scheduled to run.The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of
@scheduled_runtime
paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the@scheduled_runtime
parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleConfiguration
CreateScheduledQueryRequest.Builder scheduleConfiguration(ScheduleConfiguration scheduleConfiguration) The schedule configuration for the query.
- Parameters:
scheduleConfiguration
- The schedule configuration for the query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleConfiguration
default CreateScheduledQueryRequest.Builder scheduleConfiguration(Consumer<ScheduleConfiguration.Builder> scheduleConfiguration) The schedule configuration for the query.
This is a convenience method that creates an instance of theScheduleConfiguration.Builder
avoiding the need to create one manually viaScheduleConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscheduleConfiguration(ScheduleConfiguration)
.- Parameters:
scheduleConfiguration
- a consumer that will call methods onScheduleConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
notificationConfiguration
CreateScheduledQueryRequest.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration) Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
- Parameters:
notificationConfiguration
- Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfiguration
default CreateScheduledQueryRequest.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
This is a convenience method that creates an instance of theNotificationConfiguration.Builder
avoiding the need to create one manually viaNotificationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationConfiguration(NotificationConfiguration)
.- Parameters:
notificationConfiguration
- a consumer that will call methods onNotificationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
targetConfiguration
Configuration used for writing the result of a query.
- Parameters:
targetConfiguration
- Configuration used for writing the result of a query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetConfiguration
default CreateScheduledQueryRequest.Builder targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration) Configuration used for writing the result of a query.
This is a convenience method that creates an instance of theTargetConfiguration.Builder
avoiding the need to create one manually viaTargetConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetConfiguration(TargetConfiguration)
.- Parameters:
targetConfiguration
- a consumer that will call methods onTargetConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.
-
If CreateScheduledQuery is called without a
ClientToken
, the Query SDK generates aClientToken
on your behalf. -
After 8 hours, any request with the same
ClientToken
is treated as a new request.
- Parameters:
clientToken
- Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.-
If CreateScheduledQuery is called without a
ClientToken
, the Query SDK generates aClientToken
on your behalf. -
After 8 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.
-
-
scheduledQueryExecutionRoleArn
CreateScheduledQueryRequest.Builder scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn) The ARN for the IAM role that Timestream will assume when running the scheduled query.
- Parameters:
scheduledQueryExecutionRoleArn
- The ARN for the IAM role that Timestream will assume when running the scheduled query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs to label the scheduled query.
- Parameters:
tags
- A list of key-value pairs to label the scheduled query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs to label the scheduled query.
- Parameters:
tags
- A list of key-value pairs to label the scheduled query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs to label the scheduled query.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kmsKeyId
The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/
If ErrorReportConfiguration uses
SSE_KMS
as encryption type, the same KmsKeyId is used to encrypt the error report at rest.- Parameters:
kmsKeyId
- The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/If ErrorReportConfiguration uses
SSE_KMS
as encryption type, the same KmsKeyId is used to encrypt the error report at rest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorReportConfiguration
CreateScheduledQueryRequest.Builder errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration) Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- Parameters:
errorReportConfiguration
- Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorReportConfiguration
default CreateScheduledQueryRequest.Builder errorReportConfiguration(Consumer<ErrorReportConfiguration.Builder> errorReportConfiguration) Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
This is a convenience method that creates an instance of theErrorReportConfiguration.Builder
avoiding the need to create one manually viaErrorReportConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toerrorReportConfiguration(ErrorReportConfiguration)
.- Parameters:
errorReportConfiguration
- a consumer that will call methods onErrorReportConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateScheduledQueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateScheduledQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-