Package software.amazon.awssdk.services.cloudtrail.model

Class RefreshScheduleFrequency

java.lang.Object

software.amazon.awssdk.services.cloudtrail.model.RefreshScheduleFrequency

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class RefreshScheduleFrequency
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RefreshScheduleFrequency.Builder

Method Summary

Modifier and Type	Method	Description
static RefreshScheduleFrequency.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshScheduleFrequency.Builder>	serializableBuilderClass()
RefreshScheduleFrequency.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RefreshScheduleFrequencyUnit	unit()	The unit to use for the refresh.
String	unitAsString()	The unit to use for the refresh.
Integer	value()	The value for the refresh schedule.

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

unit

public final RefreshScheduleFrequencyUnit unit()

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS.

For the Highlights dashboard, the Unit must be HOURS.

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

Returns:

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS.

For the Highlights dashboard, the Unit must be HOURS.

See Also:

RefreshScheduleFrequencyUnit

unitAsString

public final String unitAsString()

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS.

For the Highlights dashboard, the Unit must be HOURS.

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

Returns:

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS.

For the Highlights dashboard, the Unit must be HOURS.

See Also:

RefreshScheduleFrequencyUnit

value

public final Integer 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 is 1.

For the Highlights dashboard, the Value must be 6.

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 is 1.

For the Highlights dashboard, the Value must be 6.

toBuilder

public RefreshScheduleFrequency.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RefreshScheduleFrequency.Builder,RefreshScheduleFrequency>

builder

public static RefreshScheduleFrequency.Builder builder()

serializableBuilderClass

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