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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<RefreshScheduleFrequency.Builder,RefreshScheduleFrequency>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.