Class RefreshScheduleFrequency
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RefreshScheduleFrequency.Builder,
RefreshScheduleFrequency>
Specifies the frequency for a dashboard refresh schedule.
For a custom dashboard, you can schedule a refresh for every 1, 6, 12, or 24 hours, or every day.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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()
static Class
<? extends RefreshScheduleFrequency.Builder> 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.unit()
The unit to use for the refresh.final String
The unit to use for the refresh.final Integer
value()
The value for the refresh schedule.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
unit
The unit to use for the refresh.
For custom dashboards, the unit can be
HOURS
orDAYS
.For the Highlights dashboard, the
Unit
must beHOURS
.If the service returns an enum value that is not available in the current SDK version,
unit
will returnRefreshScheduleFrequencyUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit to use for the refresh.
For custom dashboards, the unit can be
HOURS
orDAYS
.For the Highlights dashboard, the
Unit
must beHOURS
. - See Also:
-
unitAsString
The unit to use for the refresh.
For custom dashboards, the unit can be
HOURS
orDAYS
.For the Highlights dashboard, the
Unit
must beHOURS
.If the service returns an enum value that is not available in the current SDK version,
unit
will returnRefreshScheduleFrequencyUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit to use for the refresh.
For custom dashboards, the unit can be
HOURS
orDAYS
.For the Highlights dashboard, the
Unit
must beHOURS
. - See Also:
-
value
The value for the refresh schedule.
For custom dashboards, the following values are valid when the unit is
HOURS
:1
,6
,12
,24
For custom dashboards, the only valid value when the unit is
DAYS
is1
.For the Highlights dashboard, the
Value
must be6
.- Returns:
- The value for the refresh schedule.
For custom dashboards, the following values are valid when the unit is
HOURS
:1
,6
,12
,24
For custom dashboards, the only valid value when the unit is
DAYS
is1
.For the Highlights dashboard, the
Value
must be6
.
-
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<RefreshScheduleFrequency.Builder,
RefreshScheduleFrequency> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-