Package software.amazon.awssdk.services.quicksight.model

Interface RefreshFrequency.Builder

All Superinterfaces:

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

Enclosing class:

RefreshFrequency

@Mutable
@NotThreadSafe
public static interface RefreshFrequency.Builder
extends SdkPojo, CopyableBuilder<RefreshFrequency.Builder,RefreshFrequency>

Method Summary

Modifier and Type	Method	Description
RefreshFrequency.Builder	interval(String interval)	The interval between scheduled refreshes.
RefreshFrequency.Builder	interval(RefreshInterval interval)	The interval between scheduled refreshes.
default RefreshFrequency.Builder	refreshOnDay(Consumer<ScheduleRefreshOnEntity.Builder> refreshOnDay)	The day of the week that you want to schedule the refresh on.
RefreshFrequency.Builder	refreshOnDay(ScheduleRefreshOnEntity refreshOnDay)	The day of the week that you want to schedule the refresh on.
RefreshFrequency.Builder	timeOfTheDay(String timeOfTheDay)	The time of day that you want the datset to refresh.
RefreshFrequency.Builder	timezone(String timezone)	The timezone that you want the refresh schedule to use.

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

interval

RefreshFrequency.Builder interval(String interval)

The interval between scheduled refreshes. Valid values are as follows:

• MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

• DAILY: The dataset refreshes every day.

• WEEKLY: The dataset refreshes every week.

• MONTHLY: The dataset refreshes every month.

Parameters:

interval - The interval between scheduled refreshes. Valid values are as follows:

• MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

• DAILY: The dataset refreshes every day.

• WEEKLY: The dataset refreshes every week.

• MONTHLY: The dataset refreshes every month.

Returns:

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

See Also:

RefreshInterval, RefreshInterval

interval

RefreshFrequency.Builder interval(RefreshInterval interval)

The interval between scheduled refreshes. Valid values are as follows:

• MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

• DAILY: The dataset refreshes every day.

• WEEKLY: The dataset refreshes every week.

• MONTHLY: The dataset refreshes every month.

Parameters:

interval - The interval between scheduled refreshes. Valid values are as follows:

• MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

• DAILY: The dataset refreshes every day.

• WEEKLY: The dataset refreshes every week.

• MONTHLY: The dataset refreshes every month.

Returns:

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

See Also:

RefreshInterval, RefreshInterval

refreshOnDay

RefreshFrequency.Builder refreshOnDay(ScheduleRefreshOnEntity refreshOnDay)

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

Parameters:

refreshOnDay - The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

Returns:

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

refreshOnDay

default RefreshFrequency.Builder refreshOnDay(Consumer<ScheduleRefreshOnEntity.Builder> refreshOnDay)

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

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

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

Parameters:

refreshOnDay - a consumer that will call methods on ScheduleRefreshOnEntity.Builder

Returns:

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

See Also:

refreshOnDay(ScheduleRefreshOnEntity)

timezone

RefreshFrequency.Builder timezone(String timezone)

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

Parameters:

timezone - The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

Returns:

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

timeOfTheDay

RefreshFrequency.Builder timeOfTheDay(String timeOfTheDay)

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

Parameters:

timeOfTheDay - The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

Returns:

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