Interface CreateScheduledQueryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>, SdkBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>, SdkPojo, SdkRequest.Builder, TimestreamQueryRequest.Builder
Enclosing class:
CreateScheduledQueryRequest
@Mutable @NotThreadSafe public static interface CreateScheduledQueryRequest.Builder extends TimestreamQueryRequest.Builder, SdkPojo, CopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>

  • Method Details

    • name

      CreateScheduledQueryRequest.Builder name(String 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

      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.

      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 the ScheduleConfiguration.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).

      Parameters:
      scheduleConfiguration - a consumer that will call methods on ScheduleConfiguration.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 the NotificationConfiguration.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).

      Parameters:
      notificationConfiguration - a consumer that will call methods on NotificationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetConfiguration

      CreateScheduledQueryRequest.Builder targetConfiguration(TargetConfiguration 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 the TargetConfiguration.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).

      Parameters:
      targetConfiguration - a consumer that will call methods on TargetConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      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.

      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 a ClientToken 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

      CreateScheduledQueryRequest.Builder tags(Collection<Tag> 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

      CreateScheduledQueryRequest.Builder tags(Tag... 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

      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 the Tag.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<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      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.

      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 the ErrorReportConfiguration.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).

      Parameters:
      errorReportConfiguration - a consumer that will call methods on ErrorReportConfiguration.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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.