Class KnowledgeBaseRefreshScheduleSummary
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()The frequency configuration for the refresh schedule.final StringThe unique identifier for the refresh schedule.static Class<? extends KnowledgeBaseRefreshScheduleSummary.Builder> final InstantThe date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.final ScheduleStatestate()The current state of the refresh schedule.final StringThe current state of the refresh schedule.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
scheduleId
The unique identifier for the refresh schedule.
- Returns:
- The unique identifier for the refresh schedule.
-
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
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
The current state of the refresh schedule. A schedule that isn't
ENABLEDdoesn't run refreshes.If the service returns an enum value that is not available in the current SDK version,
statewill returnScheduleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the refresh schedule. A schedule that isn't
ENABLEDdoesn't run refreshes. - See Also:
-
stateAsString
The current state of the refresh schedule. A schedule that isn't
ENABLEDdoesn't run refreshes.If the service returns an enum value that is not available in the current SDK version,
statewill returnScheduleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the refresh schedule. A schedule that isn't
ENABLEDdoesn't run refreshes. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<KnowledgeBaseRefreshScheduleSummary.Builder,KnowledgeBaseRefreshScheduleSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends KnowledgeBaseRefreshScheduleSummary.Builder> serializableBuilderClass() -
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-