Class RefreshFrequency

java.lang.Object
software.amazon.awssdk.services.quicksight.model.RefreshFrequency
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RefreshFrequency.Builder,RefreshFrequency>
@Generated("software.amazon.awssdk:codegen") public final class RefreshFrequency extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RefreshFrequency.Builder,RefreshFrequency>

Specifies the interval between each scheduled refresh of a dataset.

See Also:

  • Method Details

    • interval

      public final RefreshInterval interval()

      The interval between scheduled refreshes. Valid values are as follows:

      • MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

      • DAILY: The dataset refreshes every day.

      • WEEKLY: The dataset refreshes every week.

      • MONTHLY: The dataset refreshes every month.

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

      Returns:
      The interval between scheduled refreshes. Valid values are as follows:

      • MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

      • DAILY: The dataset refreshes every day.

      • WEEKLY: The dataset refreshes every week.

      • MONTHLY: The dataset refreshes every month.

      See Also:

    • intervalAsString

      public final String intervalAsString()

      The interval between scheduled refreshes. Valid values are as follows:

      • MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

      • DAILY: The dataset refreshes every day.

      • WEEKLY: The dataset refreshes every week.

      • MONTHLY: The dataset refreshes every month.

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

      Returns:
      The interval between scheduled refreshes. Valid values are as follows:

      • MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

      • HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

      • DAILY: The dataset refreshes every day.

      • WEEKLY: The dataset refreshes every week.

      • MONTHLY: The dataset refreshes every month.

      See Also:

    • refreshOnDay

      public final ScheduleRefreshOnEntity refreshOnDay()

      The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

      Returns:
      The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

    • timezone

      public final String timezone()

      The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

      Returns:
      The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

    • timeOfTheDay

      public final String timeOfTheDay()

      The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

      Returns:
      The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

    • toBuilder

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

    • builder

      public static RefreshFrequency.Builder builder()

    • serializableBuilderClass

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