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

Interface ScheduledQueryRunSummary.Builder

All Superinterfaces:

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

Enclosing class:

ScheduledQueryRunSummary

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

Method Summary

Modifier and Type	Method	Description
default ScheduledQueryRunSummary.Builder	errorReportLocation(Consumer<ErrorReportLocation.Builder> errorReportLocation)	S3 location for error report.
ScheduledQueryRunSummary.Builder	errorReportLocation(ErrorReportLocation errorReportLocation)	S3 location for error report.
default ScheduledQueryRunSummary.Builder	executionStats(Consumer<ExecutionStats.Builder> executionStats)	Runtime statistics for a scheduled run.
ScheduledQueryRunSummary.Builder	executionStats(ExecutionStats executionStats)	Runtime statistics for a scheduled run.
ScheduledQueryRunSummary.Builder	failureReason(String failureReason)	Error message for the scheduled query in case of failure.
ScheduledQueryRunSummary.Builder	invocationTime(Instant invocationTime)	InvocationTime for this run.
default ScheduledQueryRunSummary.Builder	queryInsightsResponse(Consumer<ScheduledQueryInsightsResponse.Builder> queryInsightsResponse)	Provides various insights and metrics related to the run summary of the scheduled query.
ScheduledQueryRunSummary.Builder	queryInsightsResponse(ScheduledQueryInsightsResponse queryInsightsResponse)	Provides various insights and metrics related to the run summary of the scheduled query.
ScheduledQueryRunSummary.Builder	runStatus(String runStatus)	The status of a scheduled query run.
ScheduledQueryRunSummary.Builder	runStatus(ScheduledQueryRunStatus runStatus)	The status of a scheduled query run.
ScheduledQueryRunSummary.Builder	triggerTime(Instant triggerTime)	The actual time when the query was run.

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

Method Detail

invocationTime

ScheduledQueryRunSummary.Builder invocationTime(Instant invocationTime)

InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

Parameters:

invocationTime - InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

Returns:

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

triggerTime

ScheduledQueryRunSummary.Builder triggerTime(Instant triggerTime)

The actual time when the query was run.

Parameters:

triggerTime - The actual time when the query was run.

Returns:

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

runStatus

ScheduledQueryRunSummary.Builder runStatus(String runStatus)

The status of a scheduled query run.

Parameters:

runStatus - The status of a scheduled query run.

Returns:

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

See Also:

ScheduledQueryRunStatus, ScheduledQueryRunStatus

runStatus

ScheduledQueryRunSummary.Builder runStatus(ScheduledQueryRunStatus runStatus)

The status of a scheduled query run.

Parameters:

runStatus - The status of a scheduled query run.

Returns:

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

See Also:

ScheduledQueryRunStatus, ScheduledQueryRunStatus

executionStats

ScheduledQueryRunSummary.Builder executionStats(ExecutionStats executionStats)

Runtime statistics for a scheduled run.

Parameters:

executionStats - Runtime statistics for a scheduled run.

Returns:

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

executionStats

default ScheduledQueryRunSummary.Builder executionStats(Consumer<ExecutionStats.Builder> executionStats)

Runtime statistics for a scheduled run.

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

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

Parameters:

executionStats - a consumer that will call methods on ExecutionStats.Builder

Returns:

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

See Also:

executionStats(ExecutionStats)

queryInsightsResponse

ScheduledQueryRunSummary.Builder queryInsightsResponse(ScheduledQueryInsightsResponse queryInsightsResponse)

Provides various insights and metrics related to the run summary of the scheduled query.

Parameters:

queryInsightsResponse - Provides various insights and metrics related to the run summary of the scheduled query.

Returns:

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

queryInsightsResponse

default ScheduledQueryRunSummary.Builder queryInsightsResponse(Consumer<ScheduledQueryInsightsResponse.Builder> queryInsightsResponse)

Provides various insights and metrics related to the run summary of the scheduled query.

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

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

Parameters:

queryInsightsResponse - a consumer that will call methods on ScheduledQueryInsightsResponse.Builder

Returns:

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

See Also:

queryInsightsResponse(ScheduledQueryInsightsResponse)

errorReportLocation

ScheduledQueryRunSummary.Builder errorReportLocation(ErrorReportLocation errorReportLocation)

S3 location for error report.

Parameters:

errorReportLocation - S3 location for error report.

Returns:

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

errorReportLocation

default ScheduledQueryRunSummary.Builder errorReportLocation(Consumer<ErrorReportLocation.Builder> errorReportLocation)

S3 location for error report.

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

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

Parameters:

errorReportLocation - a consumer that will call methods on ErrorReportLocation.Builder

Returns:

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

See Also:

errorReportLocation(ErrorReportLocation)

failureReason

ScheduledQueryRunSummary.Builder failureReason(String failureReason)

Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

Parameters:

failureReason - Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

Returns:

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