Class UpdateKnowledgeBaseRefreshScheduleRequest

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account that contains the knowledge base.

      Returns:
      The ID of the Amazon Web Services account that contains the knowledge base.
    • knowledgeBaseId

      public final String knowledgeBaseId()

      The unique identifier for the knowledge base.

      Returns:
      The unique identifier for the knowledge base.
    • scheduleId

      public final String scheduleId()

      The unique identifier for the refresh schedule to update.

      Returns:
      The unique identifier for the refresh schedule to update.
    • 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. If you don't specify this parameter, the schedule keeps its existing frequency.

      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. If you don't specify this parameter, the schedule keeps its existing frequency.
    • startTime

      public final Instant startTime()

      The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base. The first refresh runs at the next scheduled time after this date and time. If you don't specify this parameter, the schedule keeps its existing start time.

      Returns:
      The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base. The first refresh runs at the next scheduled time after this date and time. If you don't specify this parameter, the schedule keeps its existing start time.
    • state

      public final ScheduleState state()

      The state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes. If you don't specify this parameter, the schedule keeps its existing state.

      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 state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes. If you don't specify this parameter, the schedule keeps its existing state.
      See Also:
    • stateAsString

      public final String stateAsString()

      The state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes. If you don't specify this parameter, the schedule keeps its existing state.

      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 state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes. If you don't specify this parameter, the schedule keeps its existing state.
      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<UpdateKnowledgeBaseRefreshScheduleRequest.Builder,UpdateKnowledgeBaseRefreshScheduleRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends UpdateKnowledgeBaseRefreshScheduleRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.