Interface KnowledgeBaseRefreshFrequency.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<KnowledgeBaseRefreshFrequency.Builder,,KnowledgeBaseRefreshFrequency> SdkBuilder<KnowledgeBaseRefreshFrequency.Builder,,KnowledgeBaseRefreshFrequency> SdkPojo
- Enclosing class:
KnowledgeBaseRefreshFrequency
-
Method Summary
Modifier and TypeMethodDescriptionThe interval at which the schedule refreshes the knowledge base.interval(KbRefreshInterval interval) The interval at which the schedule refreshes the knowledge base.refreshOnDay(Consumer<KnowledgeBaseScheduleRefreshOnEntity.Builder> refreshOnDay) The day on which the refresh runs.refreshOnDay(KnowledgeBaseScheduleRefreshOnEntity refreshOnDay) The day on which the refresh runs.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
-
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 inRefreshOnDay.DayOfWeek. -
MONTHLY– The schedule refreshes the knowledge base once each month, on the day that you specify inRefreshOnDay.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 anInvalidParameterValueException.
For
DAILY,WEEKLY, andMONTHLYintervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.- Parameters:
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 inRefreshOnDay.DayOfWeek. -
MONTHLY– The schedule refreshes the knowledge base once each month, on the day that you specify inRefreshOnDay.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 anInvalidParameterValueException.
For
DAILY,WEEKLY, andMONTHLYintervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 inRefreshOnDay.DayOfWeek. -
MONTHLY– The schedule refreshes the knowledge base once each month, on the day that you specify inRefreshOnDay.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 anInvalidParameterValueException.
For
DAILY,WEEKLY, andMONTHLYintervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.- Parameters:
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 inRefreshOnDay.DayOfWeek. -
MONTHLY– The schedule refreshes the knowledge base once each month, on the day that you specify inRefreshOnDay.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 anInvalidParameterValueException.
For
DAILY,WEEKLY, andMONTHLYintervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
refreshOnDay
KnowledgeBaseRefreshFrequency.Builder refreshOnDay(KnowledgeBaseScheduleRefreshOnEntity refreshOnDay) The day on which the refresh runs. This parameter is required for a
WEEKLYorMONTHLYinterval: specify the day of the week forWEEKLYor the day of the month forMONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for aDAILYorHOURLYinterval.- Parameters:
refreshOnDay- The day on which the refresh runs. This parameter is required for aWEEKLYorMONTHLYinterval: specify the day of the week forWEEKLYor the day of the month forMONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for aDAILYorHOURLYinterval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
refreshOnDay
default KnowledgeBaseRefreshFrequency.Builder refreshOnDay(Consumer<KnowledgeBaseScheduleRefreshOnEntity.Builder> refreshOnDay) The day on which the refresh runs. This parameter is required for a
This is a convenience method that creates an instance of theWEEKLYorMONTHLYinterval: specify the day of the week forWEEKLYor the day of the month forMONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for aDAILYorHOURLYinterval.KnowledgeBaseScheduleRefreshOnEntity.Builderavoiding the need to create one manually viaKnowledgeBaseScheduleRefreshOnEntity.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torefreshOnDay(KnowledgeBaseScheduleRefreshOnEntity).- Parameters:
refreshOnDay- a consumer that will call methods onKnowledgeBaseScheduleRefreshOnEntity.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-