software.amazon.awssdk.services.quicksight.model

Interface RefreshSchedule.Builder

All Superinterfaces:

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

Enclosing class:

RefreshSchedule

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

Method Summary

Modifier and Type	Method and Description
RefreshSchedule.Builder	arn(String arn) The Amazon Resource Name (ARN) for the refresh schedule.
RefreshSchedule.Builder	refreshType(IngestionType refreshType) The type of refresh that a datset undergoes.
RefreshSchedule.Builder	refreshType(String refreshType) The type of refresh that a datset undergoes.
default RefreshSchedule.Builder	scheduleFrequency(Consumer<RefreshFrequency.Builder> scheduleFrequency) The frequency for the refresh schedule.
RefreshSchedule.Builder	scheduleFrequency(RefreshFrequency scheduleFrequency) The frequency for the refresh schedule.
RefreshSchedule.Builder	scheduleId(String scheduleId) An identifier for the refresh schedule.
RefreshSchedule.Builder	startAfterDateTime(Instant startAfterDateTime) Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

scheduleId

RefreshSchedule.Builder scheduleId(String scheduleId)

An identifier for the refresh schedule.

Parameters:

scheduleId - An identifier for the refresh schedule.

Returns:

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

scheduleFrequency

RefreshSchedule.Builder scheduleFrequency(RefreshFrequency scheduleFrequency)

The frequency for the refresh schedule.

Parameters:

scheduleFrequency - The frequency for the refresh schedule.

Returns:

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

scheduleFrequency

default RefreshSchedule.Builder scheduleFrequency(Consumer<RefreshFrequency.Builder> scheduleFrequency)

The frequency for the refresh schedule.

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

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

Parameters:

scheduleFrequency - a consumer that will call methods on RefreshFrequency.Builder

Returns:

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

See Also:

scheduleFrequency(RefreshFrequency)

startAfterDateTime

RefreshSchedule.Builder startAfterDateTime(Instant startAfterDateTime)

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

Parameters:

startAfterDateTime - Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

Returns:

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

refreshType

RefreshSchedule.Builder refreshType(String refreshType)

The type of refresh that a datset undergoes. Valid values are as follows:

• FULL_REFRESH: A complete refresh of a dataset.

• INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

Parameters:

refreshType - The type of refresh that a datset undergoes. Valid values are as follows:

• FULL_REFRESH: A complete refresh of a dataset.

• INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

Returns:

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

See Also:

IngestionType, IngestionType

refreshType

RefreshSchedule.Builder refreshType(IngestionType refreshType)

The type of refresh that a datset undergoes. Valid values are as follows:

• FULL_REFRESH: A complete refresh of a dataset.

• INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

Parameters:

refreshType - The type of refresh that a datset undergoes. Valid values are as follows:

• FULL_REFRESH: A complete refresh of a dataset.

• INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

Returns:

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

See Also:

IngestionType, IngestionType

arn

RefreshSchedule.Builder arn(String arn)

The Amazon Resource Name (ARN) for the refresh schedule.

Parameters:

arn - The Amazon Resource Name (ARN) for the refresh schedule.

Returns:

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