Class KnowledgeBaseRefreshScheduleSummary

java.lang.Object
software.amazon.awssdk.services.quicksight.model.KnowledgeBaseRefreshScheduleSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseRefreshScheduleSummary.Builder,KnowledgeBaseRefreshScheduleSummary>

@Generated("software.amazon.awssdk:codegen") public final class KnowledgeBaseRefreshScheduleSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseRefreshScheduleSummary.Builder,KnowledgeBaseRefreshScheduleSummary>

A summary of a knowledge base refresh schedule, including its identifier, frequency, start time, and state. The DescribeKnowledgeBaseRefreshSchedule and ListKnowledgeBaseRefreshSchedules operations return this summary.

See Also:
  • Method Details

    • scheduleId

      public final String scheduleId()

      The unique identifier for the refresh schedule.

      Returns:
      The unique identifier for the refresh schedule.
    • scheduleFrequency

      public final KnowledgeBaseRefreshFrequency scheduleFrequency()

      The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs.

      Returns:
      The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs.
    • startTime

      public final Instant startTime()

      The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.

      Returns:
      The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.
    • state

      public final ScheduleState state()

      The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.

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

      Returns:
      The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.
      See Also:
    • stateAsString

      public final String stateAsString()

      The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.

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

      Returns:
      The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.
      See Also:
    • 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<KnowledgeBaseRefreshScheduleSummary.Builder,KnowledgeBaseRefreshScheduleSummary>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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