Class CreateKnowledgeBaseRefreshScheduleRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateKnowledgeBaseRefreshScheduleRequest.Builder,CreateKnowledgeBaseRefreshScheduleRequest>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe ID of the Amazon Web Services account that contains the knowledge base.builder()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) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final StringThe unique identifier for the knowledge base.The frequency configuration for the refresh schedule.final StringA unique identifier for the knowledge base refresh schedule.static Class<? extends CreateKnowledgeBaseRefreshScheduleRequest.Builder> final InstantThe date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.final ScheduleStatestate()The state that you want the refresh schedule to have when you create it.final StringThe state that you want the refresh schedule to have when you create it.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The unique identifier for the knowledge base.
- Returns:
- The unique identifier for the knowledge base.
-
scheduleId
A unique identifier for the knowledge base refresh schedule.
- Returns:
- A unique identifier for the knowledge base 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. The first refresh runs at the next scheduled time after this date and time. If you don't specify a value, the schedule becomes active immediately, and the first refresh runs at the next scheduled 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 a value, the schedule becomes active immediately, and the first refresh runs at the next scheduled time.
-
state
The state that you want the refresh schedule to have when you create it. If you don't specify a state, the schedule is created in the
ENABLEDstate. A schedule that isn'tENABLEDdoesn'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 state that you want the refresh schedule to have when you create it. If you don't specify a state,
the schedule is created in the
ENABLEDstate. A schedule that isn'tENABLEDdoesn't run refreshes. - See Also:
-
stateAsString
The state that you want the refresh schedule to have when you create it. If you don't specify a state, the schedule is created in the
ENABLEDstate. A schedule that isn'tENABLEDdoesn'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 state that you want the refresh schedule to have when you create it. If you don't specify a state,
the schedule is created in the
ENABLEDstate. A schedule that isn'tENABLEDdoesn'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<CreateKnowledgeBaseRefreshScheduleRequest.Builder,CreateKnowledgeBaseRefreshScheduleRequest> - Specified by:
toBuilderin classQuickSightRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateKnowledgeBaseRefreshScheduleRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
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
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-