Class KnowledgeBaseRefreshFrequency

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

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

Specifies how often a knowledge base refresh schedule runs and, for weekly or monthly schedules, which day the refresh runs.

See Also:
  • Method Details

    • interval

      public final KbRefreshInterval interval()

      The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

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

      Returns:
      The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

      See Also:
    • intervalAsString

      public final String intervalAsString()

      The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

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

      Returns:
      The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

      See Also:
    • refreshOnDay

      public final KnowledgeBaseScheduleRefreshOnEntity refreshOnDay()

      The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.

      Returns:
      The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.
    • 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<KnowledgeBaseRefreshFrequency.Builder,KnowledgeBaseRefreshFrequency>
      Returns:
      a builder for type T
    • builder

      public static KnowledgeBaseRefreshFrequency.Builder builder()
    • serializableBuilderClass

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