Package software.amazon.awssdk.services.timestreamquery.model

Interface ScheduledQueryDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ScheduledQueryDescription.Builder,ScheduledQueryDescription>, SdkBuilder<ScheduledQueryDescription.Builder,ScheduledQueryDescription>, SdkPojo

Enclosing class:

ScheduledQueryDescription

public static interface ScheduledQueryDescription.Builder
extends SdkPojo, CopyableBuilder<ScheduledQueryDescription.Builder,ScheduledQueryDescription>

Method Summary

Modifier and Type	Method	Description
ScheduledQueryDescription.Builder	arn(String arn)	Scheduled query ARN.
ScheduledQueryDescription.Builder	creationTime(Instant creationTime)	Creation time of the scheduled query.
default ScheduledQueryDescription.Builder	errorReportConfiguration(Consumer<ErrorReportConfiguration.Builder> errorReportConfiguration)	Error-reporting configuration for the scheduled query.
ScheduledQueryDescription.Builder	errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)	Error-reporting configuration for the scheduled query.
ScheduledQueryDescription.Builder	kmsKeyId(String kmsKeyId)	A customer provided KMS key used to encrypt the scheduled query resource.
default ScheduledQueryDescription.Builder	lastRunSummary(Consumer<ScheduledQueryRunSummary.Builder> lastRunSummary)	Runtime summary for the last scheduled query run.
ScheduledQueryDescription.Builder	lastRunSummary(ScheduledQueryRunSummary lastRunSummary)	Runtime summary for the last scheduled query run.
ScheduledQueryDescription.Builder	name(String name)	Name of the scheduled query.
ScheduledQueryDescription.Builder	nextInvocationTime(Instant nextInvocationTime)	The next time the scheduled query is scheduled to run.
default ScheduledQueryDescription.Builder	notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)	Notification configuration.
ScheduledQueryDescription.Builder	notificationConfiguration(NotificationConfiguration notificationConfiguration)	Notification configuration.
ScheduledQueryDescription.Builder	previousInvocationTime(Instant previousInvocationTime)	Last time the query was run.
ScheduledQueryDescription.Builder	queryString(String queryString)	The query to be run.
ScheduledQueryDescription.Builder	recentlyFailedRuns(Collection<ScheduledQueryRunSummary> recentlyFailedRuns)	Runtime summary for the last five failed scheduled query runs.
ScheduledQueryDescription.Builder	recentlyFailedRuns(Consumer<ScheduledQueryRunSummary.Builder>... recentlyFailedRuns)	Runtime summary for the last five failed scheduled query runs.
ScheduledQueryDescription.Builder	recentlyFailedRuns(ScheduledQueryRunSummary... recentlyFailedRuns)	Runtime summary for the last five failed scheduled query runs.
default ScheduledQueryDescription.Builder	scheduleConfiguration(Consumer<ScheduleConfiguration.Builder> scheduleConfiguration)	Schedule configuration.
ScheduledQueryDescription.Builder	scheduleConfiguration(ScheduleConfiguration scheduleConfiguration)	Schedule configuration.
ScheduledQueryDescription.Builder	scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)	IAM role that Timestream uses to run the schedule query.
ScheduledQueryDescription.Builder	state(String state)	State of the scheduled query.
ScheduledQueryDescription.Builder	state(ScheduledQueryState state)	State of the scheduled query.
default ScheduledQueryDescription.Builder	targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)	Scheduled query target store configuration.
ScheduledQueryDescription.Builder	targetConfiguration(TargetConfiguration targetConfiguration)	Scheduled query target store configuration.

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

Method Details

arn

ScheduledQueryDescription.Builder arn(String arn)

Scheduled query ARN.

Parameters:

arn - Scheduled query ARN.

Returns:

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

name

ScheduledQueryDescription.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

ScheduledQueryDescription.Builder queryString(String queryString)

The query to be run.

Parameters:

queryString - The query to be run.

Returns:

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

creationTime

ScheduledQueryDescription.Builder creationTime(Instant creationTime)

Creation time of the scheduled query.

Parameters:

creationTime - Creation time of the scheduled query.

Returns:

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

state

ScheduledQueryDescription.Builder state(String state)

State of the scheduled query.

Parameters:

state - State of the scheduled query.

Returns:

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

See Also:

• ScheduledQueryState
• ScheduledQueryState

state

ScheduledQueryDescription.Builder state(ScheduledQueryState state)

State of the scheduled query.

Parameters:

state - State of the scheduled query.

Returns:

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

See Also:

• ScheduledQueryState
• ScheduledQueryState

previousInvocationTime

ScheduledQueryDescription.Builder previousInvocationTime(Instant previousInvocationTime)

Last time the query was run.

Parameters:

previousInvocationTime - Last time the query was run.

Returns:

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

nextInvocationTime

ScheduledQueryDescription.Builder nextInvocationTime(Instant nextInvocationTime)

The next time the scheduled query is scheduled to run.

Parameters:

nextInvocationTime - The next time the scheduled query is scheduled to run.

Returns:

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

scheduleConfiguration

ScheduledQueryDescription.Builder scheduleConfiguration(ScheduleConfiguration scheduleConfiguration)

Schedule configuration.

Parameters:

scheduleConfiguration - Schedule configuration.

Returns:

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

scheduleConfiguration

default ScheduledQueryDescription.Builder scheduleConfiguration(Consumer<ScheduleConfiguration.Builder> scheduleConfiguration)

Schedule configuration.

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:

• scheduleConfiguration(ScheduleConfiguration)

notificationConfiguration

ScheduledQueryDescription.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration)

Notification configuration.

Parameters:

notificationConfiguration - Notification configuration.

Returns:

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

notificationConfiguration

default ScheduledQueryDescription.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)

Notification configuration.

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:

• notificationConfiguration(NotificationConfiguration)

targetConfiguration

ScheduledQueryDescription.Builder targetConfiguration(TargetConfiguration targetConfiguration)

Scheduled query target store configuration.

Parameters:

targetConfiguration - Scheduled query target store configuration.

Returns:

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

targetConfiguration

default ScheduledQueryDescription.Builder targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)

Scheduled query target store configuration.

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:

• targetConfiguration(TargetConfiguration)

scheduledQueryExecutionRoleArn

ScheduledQueryDescription.Builder scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)

IAM role that Timestream uses to run the schedule query.

Parameters:

scheduledQueryExecutionRoleArn - IAM role that Timestream uses to run the schedule query.

Returns:

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

kmsKeyId

ScheduledQueryDescription.Builder kmsKeyId(String kmsKeyId)

A customer provided KMS key used to encrypt the scheduled query resource.

Parameters:

kmsKeyId - A customer provided KMS key used to encrypt the scheduled query resource.

Returns:

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

errorReportConfiguration

ScheduledQueryDescription.Builder errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)

Error-reporting configuration for the scheduled query.

Parameters:

errorReportConfiguration - Error-reporting configuration for the scheduled query.

Returns:

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

errorReportConfiguration

default ScheduledQueryDescription.Builder errorReportConfiguration(Consumer<ErrorReportConfiguration.Builder> errorReportConfiguration)

Error-reporting configuration for the scheduled query.

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:

• errorReportConfiguration(ErrorReportConfiguration)

lastRunSummary

ScheduledQueryDescription.Builder lastRunSummary(ScheduledQueryRunSummary lastRunSummary)

Runtime summary for the last scheduled query run.

Parameters:

lastRunSummary - Runtime summary for the last scheduled query run.

Returns:

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

lastRunSummary

default ScheduledQueryDescription.Builder lastRunSummary(Consumer<ScheduledQueryRunSummary.Builder> lastRunSummary)

Runtime summary for the last scheduled query run.

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

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

Parameters:

lastRunSummary - a consumer that will call methods on ScheduledQueryRunSummary.Builder

Returns:

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

See Also:

• lastRunSummary(ScheduledQueryRunSummary)

recentlyFailedRuns

ScheduledQueryDescription.Builder recentlyFailedRuns(Collection<ScheduledQueryRunSummary> recentlyFailedRuns)

Runtime summary for the last five failed scheduled query runs.

Parameters:

recentlyFailedRuns - Runtime summary for the last five failed scheduled query runs.

Returns:

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

recentlyFailedRuns

ScheduledQueryDescription.Builder recentlyFailedRuns(ScheduledQueryRunSummary... recentlyFailedRuns)

Runtime summary for the last five failed scheduled query runs.

Parameters:

recentlyFailedRuns - Runtime summary for the last five failed scheduled query runs.

Returns:

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

recentlyFailedRuns

ScheduledQueryDescription.Builder recentlyFailedRuns(Consumer<ScheduledQueryRunSummary.Builder>... recentlyFailedRuns)

Runtime summary for the last five failed scheduled query runs.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recentlyFailedRuns(List<ScheduledQueryRunSummary>).

Parameters:

recentlyFailedRuns - a consumer that will call methods on ScheduledQueryRunSummary.Builder

Returns:

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

See Also:

• recentlyFailedRuns(java.util.Collection<ScheduledQueryRunSummary>)