Class RefreshSchedule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RefreshSchedule.Builder,
RefreshSchedule>
The refresh schedule of a dataset.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) for the refresh schedule.static RefreshSchedule.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final IngestionType
The type of refresh that a datset undergoes.final String
The type of refresh that a datset undergoes.final RefreshFrequency
The frequency for the refresh schedule.final String
An identifier for the refresh schedule.static Class
<? extends RefreshSchedule.Builder> final Instant
Time after which the refresh schedule can be started, expressed inYYYY-MM-DDTHH:MM:SS
format.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
scheduleId
An identifier for the refresh schedule.
- Returns:
- An identifier for the refresh schedule.
-
scheduleFrequency
The frequency for the refresh schedule.
- Returns:
- The frequency for the refresh schedule.
-
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
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 returnIngestionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrefreshTypeAsString()
.- 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:
-
-
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 returnIngestionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrefreshTypeAsString()
.- 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:
-
-
arn
The Amazon Resource Name (ARN) for the refresh schedule.
- Returns:
- The Amazon Resource Name (ARN) for the refresh schedule.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RefreshSchedule.Builder,
RefreshSchedule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-