Interface KnowledgeBaseRefreshScheduleSummary.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<KnowledgeBaseRefreshScheduleSummary.Builder,,KnowledgeBaseRefreshScheduleSummary> SdkBuilder<KnowledgeBaseRefreshScheduleSummary.Builder,,KnowledgeBaseRefreshScheduleSummary> SdkPojo
- Enclosing class:
KnowledgeBaseRefreshScheduleSummary
-
Method Summary
Modifier and TypeMethodDescriptionscheduleFrequency(Consumer<KnowledgeBaseRefreshFrequency.Builder> scheduleFrequency) The frequency configuration for the refresh schedule.scheduleFrequency(KnowledgeBaseRefreshFrequency scheduleFrequency) The frequency configuration for the refresh schedule.scheduleId(String scheduleId) The unique identifier for the refresh schedule.The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.The current state of the refresh schedule.state(ScheduleState state) The current state of the refresh schedule.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
scheduleId
The unique identifier for the refresh schedule.
- Parameters:
scheduleId- The unique identifier for the refresh schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleFrequency
KnowledgeBaseRefreshScheduleSummary.Builder scheduleFrequency(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleFrequency
default KnowledgeBaseRefreshScheduleSummary.Builder scheduleFrequency(Consumer<KnowledgeBaseRefreshFrequency.Builder> 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.
This is a convenience method that creates an instance of theKnowledgeBaseRefreshFrequency.Builderavoiding the need to create one manually viaKnowledgeBaseRefreshFrequency.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toscheduleFrequency(KnowledgeBaseRefreshFrequency).- Parameters:
scheduleFrequency- a consumer that will call methods onKnowledgeBaseRefreshFrequency.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startTime
The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.
- Parameters:
startTime- The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The current state of the refresh schedule. A schedule that isn't
ENABLEDdoesn't run refreshes.- Parameters:
state- The current state of the refresh schedule. A schedule that isn'tENABLEDdoesn't run refreshes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current state of the refresh schedule. A schedule that isn't
ENABLEDdoesn't run refreshes.- Parameters:
state- The current state of the refresh schedule. A schedule that isn'tENABLEDdoesn't run refreshes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-