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

Class RefreshSchedule

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RefreshSchedule

All Implemented Interfaces:

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

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

The refresh schedule of a dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RefreshSchedule.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) for the refresh schedule.
static RefreshSchedule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IngestionType	refreshType()	The type of refresh that a datset undergoes.
String	refreshTypeAsString()	The type of refresh that a datset undergoes.
RefreshFrequency	scheduleFrequency()	The frequency for the refresh schedule.
String	scheduleId()	An identifier for the refresh schedule.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshSchedule.Builder>	serializableBuilderClass()
Instant	startAfterDateTime()	Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
RefreshSchedule.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

scheduleId

public final String scheduleId()

An identifier for the refresh schedule.

Returns:

An identifier for the refresh schedule.

scheduleFrequency

public final RefreshFrequency scheduleFrequency()

The frequency for the refresh schedule.

Returns:

The frequency for the refresh schedule.

startAfterDateTime

public final Instant startAfterDateTime()

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

Returns:

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

refreshType

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

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

Returns:

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.

See Also:

IngestionType

refreshTypeAsString

public final String refreshTypeAsString()

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.

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

Returns:

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.

See Also:

IngestionType

arn

public final String arn()

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

Returns:

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

toBuilder

public RefreshSchedule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RefreshSchedule.Builder,RefreshSchedule>

builder

public static RefreshSchedule.Builder builder()

serializableBuilderClass

public static Class<? extends RefreshSchedule.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