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

Class RefreshFrequency

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RefreshFrequency

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RefreshFrequency.Builder,RefreshFrequency>

@Generated("software.amazon.awssdk:codegen")
public final class RefreshFrequency
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RefreshFrequency.Builder,RefreshFrequency>

Specifies the interval between each scheduled refresh of a dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RefreshFrequency.Builder

Method Summary

Modifier and Type	Method	Description
static RefreshFrequency.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RefreshInterval	interval()	The interval between scheduled refreshes.
String	intervalAsString()	The interval between scheduled refreshes.
ScheduleRefreshOnEntity	refreshOnDay()	The day of the week that you want to schedule the refresh on.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshFrequency.Builder>	serializableBuilderClass()
String	timeOfTheDay()	The time of day that you want the datset to refresh.
String	timezone()	The timezone that you want the refresh schedule to use.
RefreshFrequency.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

interval

public final 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.

If the service returns an enum value that is not available in the current SDK version, interval will return RefreshInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalAsString().

Returns:

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.

See Also:

RefreshInterval

intervalAsString

public final String intervalAsString()

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.

If the service returns an enum value that is not available in the current SDK version, interval will return RefreshInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalAsString().

Returns:

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.

See Also:

RefreshInterval

refreshOnDay

public final 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.

Returns:

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

timezone

public final 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().

Returns:

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

timeOfTheDay

public final 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.

Returns:

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.

toBuilder

public RefreshFrequency.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RefreshFrequency.Builder,RefreshFrequency>

builder

public static RefreshFrequency.Builder builder()

serializableBuilderClass

public static Class<? extends RefreshFrequency.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo