Class KnowledgeBaseRefreshFrequency
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<KnowledgeBaseRefreshFrequency.Builder,KnowledgeBaseRefreshFrequency>
Specifies how often a knowledge base refresh schedule runs and, for weekly or monthly schedules, which day the refresh runs.
- 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()final KbRefreshIntervalinterval()The interval at which the schedule refreshes the knowledge base.final StringThe interval at which the schedule refreshes the knowledge base.The day on which the refresh runs.static Class<? extends KnowledgeBaseRefreshFrequency.Builder> 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
-
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.If the service returns an enum value that is not available in the current SDK version,
intervalwill returnKbRefreshInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromintervalAsString().- Returns:
- 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. -
- See Also:
-
-
intervalAsString
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.If the service returns an enum value that is not available in the current SDK version,
intervalwill returnKbRefreshInterval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromintervalAsString().- Returns:
- 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. -
- See Also:
-
-
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.- Returns:
- 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.
-
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<KnowledgeBaseRefreshFrequency.Builder,KnowledgeBaseRefreshFrequency> - Returns:
- a builder for type T
-
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.
-