Class TopicRefreshSchedule

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

A structure that represents a topic refresh schedule.

See Also:

  • Method Details

    • isEnabled

      public final Boolean isEnabled()

      A Boolean value that controls whether to schedule is enabled.

      Returns:
      A Boolean value that controls whether to schedule is enabled.

    • basedOnSpiceSchedule

      public final Boolean basedOnSpiceSchedule()

      A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

      Returns:
      A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

    • startingAt

      public final Instant startingAt()

      The starting date and time for the refresh schedule.

      Returns:
      The starting date and time for the refresh schedule.

    • timezone

      public final String timezone()

      The timezone that you want the refresh schedule to use.

      Returns:
      The timezone that you want the refresh schedule to use.

    • repeatAt

      public final String repeatAt()

      The time of day when the refresh should run, for example, Monday-Sunday.

      Returns:
      The time of day when the refresh should run, for example, Monday-Sunday.

    • topicScheduleType

      public final TopicScheduleType topicScheduleType()

      The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

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

      Returns:
      The type of refresh schedule. Valid values for this structure are HOURLY, DAILY , WEEKLY, and MONTHLY.
      See Also:

    • topicScheduleTypeAsString

      public final String topicScheduleTypeAsString()

      The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

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

      Returns:
      The type of refresh schedule. Valid values for this structure are HOURLY, DAILY , WEEKLY, and MONTHLY.
      See Also:

    • toBuilder

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

    • builder

      public static TopicRefreshSchedule.Builder builder()

    • serializableBuilderClass

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