public static interface CreateScheduledQueryRequest.Builder extends TimestreamQueryRequest.Builder, SdkPojo, CopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateScheduledQueryRequest.Builder |
clientToken(String clientToken)
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same
request repeatedly will produce the same result.
|
default CreateScheduledQueryRequest.Builder |
errorReportConfiguration(Consumer<ErrorReportConfiguration.Builder> errorReportConfiguration)
Configuration for error reporting.
|
CreateScheduledQueryRequest.Builder |
errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)
Configuration for error reporting.
|
CreateScheduledQueryRequest.Builder |
kmsKeyId(String kmsKeyId)
The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
|
CreateScheduledQueryRequest.Builder |
name(String name)
Name of the scheduled query.
|
default CreateScheduledQueryRequest.Builder |
notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)
Notification configuration for the scheduled query.
|
CreateScheduledQueryRequest.Builder |
notificationConfiguration(NotificationConfiguration notificationConfiguration)
Notification configuration for the scheduled query.
|
CreateScheduledQueryRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateScheduledQueryRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateScheduledQueryRequest.Builder |
queryString(String queryString)
The query string to run.
|
default CreateScheduledQueryRequest.Builder |
scheduleConfiguration(Consumer<ScheduleConfiguration.Builder> scheduleConfiguration)
The schedule configuration for the query.
|
CreateScheduledQueryRequest.Builder |
scheduleConfiguration(ScheduleConfiguration scheduleConfiguration)
The schedule configuration for the query.
|
CreateScheduledQueryRequest.Builder |
scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)
The ARN for the IAM role that Timestream will assume when running the scheduled query.
|
CreateScheduledQueryRequest.Builder |
tags(Collection<Tag> tags)
A list of key-value pairs to label the scheduled query.
|
CreateScheduledQueryRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to label the scheduled query.
|
CreateScheduledQueryRequest.Builder |
tags(Tag... tags)
A list of key-value pairs to label the scheduled query.
|
default CreateScheduledQueryRequest.Builder |
targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)
Configuration used for writing the result of a query.
|
CreateScheduledQueryRequest.Builder |
targetConfiguration(TargetConfiguration targetConfiguration)
Configuration used for writing the result of a query.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateScheduledQueryRequest.Builder name(String name)
Name of the scheduled query.
name - Name of the scheduled query.CreateScheduledQueryRequest.Builder queryString(String 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.
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.
CreateScheduledQueryRequest.Builder scheduleConfiguration(ScheduleConfiguration scheduleConfiguration)
The schedule configuration for the query.
scheduleConfiguration - The schedule configuration for the query.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 via ScheduleConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to scheduleConfiguration(ScheduleConfiguration).
scheduleConfiguration - a consumer that will call methods on ScheduleConfiguration.BuilderscheduleConfiguration(ScheduleConfiguration)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.
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.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 via NotificationConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to notificationConfiguration(NotificationConfiguration).
notificationConfiguration - a consumer that will call methods on NotificationConfiguration.BuildernotificationConfiguration(NotificationConfiguration)CreateScheduledQueryRequest.Builder targetConfiguration(TargetConfiguration targetConfiguration)
Configuration used for writing the result of a query.
targetConfiguration - Configuration used for writing the result of a query.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 via TargetConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to targetConfiguration(TargetConfiguration).
targetConfiguration - a consumer that will call methods on TargetConfiguration.BuildertargetConfiguration(TargetConfiguration)CreateScheduledQueryRequest.Builder clientToken(String 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 a
ClientToken on your behalf.
After 8 hours, any request with the same ClientToken is treated as a new request.
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 a
ClientToken on your behalf.
After 8 hours, any request with the same ClientToken is treated as a new request.
CreateScheduledQueryRequest.Builder scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)
The ARN for the IAM role that Timestream will assume when running the scheduled query.
scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the scheduled query.CreateScheduledQueryRequest.Builder tags(Collection<Tag> tags)
A list of key-value pairs to label the scheduled query.
tags - A list of key-value pairs to label the scheduled query.CreateScheduledQueryRequest.Builder tags(Tag... tags)
A list of key-value pairs to label the scheduled query.
tags - A list of key-value pairs to label the scheduled query.CreateScheduledQueryRequest.Builder tags(Consumer<Tag.Builder>... 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 via Tag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #tags(List.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) CreateScheduledQueryRequest.Builder kmsKeyId(String 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.
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.
CreateScheduledQueryRequest.Builder errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
errorReportConfiguration - Configuration for error reporting. Error reports will be generated when a problem is encountered when
writing the query results.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 via ErrorReportConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to errorReportConfiguration(ErrorReportConfiguration).
errorReportConfiguration - a consumer that will call methods on ErrorReportConfiguration.BuildererrorReportConfiguration(ErrorReportConfiguration)CreateScheduledQueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateScheduledQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.