Class SyncSchedule

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

The recurring schedule on which a managed knowledge base connector automatically syncs its data source. Specify exactly one of daily, weekly, or monthly.

See Also:

  • Method Details

    • daily

      public final DailySchedule daily()

      A daily sync that runs once a day at a system-chosen off-peak time. The run time is not configurable.

      Returns:
      A daily sync that runs once a day at a system-chosen off-peak time. The run time is not configurable.

    • weekly

      public final WeeklySchedule weekly()

      A weekly sync that runs once a week on the specified day of the week.

      Returns:
      A weekly sync that runs once a week on the specified day of the week.

    • monthly

      public final MonthlySchedule monthly()

      A monthly sync that runs once a month on the specified day of the month.

      Returns:
      A monthly sync that runs once a month on the specified day of the month.

    • toBuilder

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

    • builder

      public static SyncSchedule.Builder builder()

    • serializableBuilderClass

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

    • fromDaily

      public static SyncSchedule fromDaily(DailySchedule daily)
      Create an instance of this class with daily() initialized to the given value.

      A daily sync that runs once a day at a system-chosen off-peak time. The run time is not configurable.

      Parameters:
      daily - A daily sync that runs once a day at a system-chosen off-peak time. The run time is not configurable.

    • fromDaily

      public static SyncSchedule fromDaily(Consumer<DailySchedule.Builder> daily)
      Create an instance of this class with daily() initialized to the given value.

      A daily sync that runs once a day at a system-chosen off-peak time. The run time is not configurable.

      Parameters:
      daily - A daily sync that runs once a day at a system-chosen off-peak time. The run time is not configurable.

    • fromWeekly

      public static SyncSchedule fromWeekly(WeeklySchedule weekly)
      Create an instance of this class with weekly() initialized to the given value.

      A weekly sync that runs once a week on the specified day of the week.

      Parameters:
      weekly - A weekly sync that runs once a week on the specified day of the week.

    • fromWeekly

      public static SyncSchedule fromWeekly(Consumer<WeeklySchedule.Builder> weekly)
      Create an instance of this class with weekly() initialized to the given value.

      A weekly sync that runs once a week on the specified day of the week.

      Parameters:
      weekly - A weekly sync that runs once a week on the specified day of the week.

    • fromMonthly

      public static SyncSchedule fromMonthly(MonthlySchedule monthly)
      Create an instance of this class with monthly() initialized to the given value.

      A monthly sync that runs once a month on the specified day of the month.

      Parameters:
      monthly - A monthly sync that runs once a month on the specified day of the month.

    • fromMonthly

      public static SyncSchedule fromMonthly(Consumer<MonthlySchedule.Builder> monthly)
      Create an instance of this class with monthly() initialized to the given value.

      A monthly sync that runs once a month on the specified day of the month.

      Parameters:
      monthly - A monthly sync that runs once a month on the specified day of the month.

    • type

      public SyncSchedule.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be SyncSchedule.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be SyncSchedule.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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