Class RefreshSchedule

java.lang.Object
software.amazon.awssdk.services.cloudtrail.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 schedule for a dashboard refresh.

See Also:

  • Method Details

    • frequency

      public final RefreshScheduleFrequency frequency()

      The frequency at which you want the dashboard refreshed.

      Returns:
      The frequency at which you want the dashboard refreshed.

    • status

      public final RefreshScheduleStatus status()

      Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

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

      Returns:
      Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.
      See Also:

    • statusAsString

      public final String statusAsString()

      Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

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

      Returns:
      Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.
      See Also:

    • timeOfDay

      public final String timeOfDay()

      The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.

      Returns:
      The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.

    • toBuilder

      public RefreshSchedule.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<RefreshSchedule.Builder,RefreshSchedule>
      Returns:
      a builder for type T

    • 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)
      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.