Interface CreateKnowledgeBaseRefreshScheduleRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateKnowledgeBaseRefreshScheduleRequest.Builder,,CreateKnowledgeBaseRefreshScheduleRequest> QuickSightRequest.Builder,SdkBuilder<CreateKnowledgeBaseRefreshScheduleRequest.Builder,,CreateKnowledgeBaseRefreshScheduleRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateKnowledgeBaseRefreshScheduleRequest
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the knowledge base.knowledgeBaseId(String knowledgeBaseId) The unique identifier for the knowledge base.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.scheduleFrequency(Consumer<KnowledgeBaseRefreshFrequency.Builder> scheduleFrequency) The frequency configuration for the refresh schedule.scheduleFrequency(KnowledgeBaseRefreshFrequency scheduleFrequency) The frequency configuration for the refresh schedule.scheduleId(String scheduleId) A unique identifier for the knowledge base refresh schedule.The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.The state that you want the refresh schedule to have when you create it.state(ScheduleState state) The state that you want the refresh schedule to have when you create it.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
awsAccountId
The ID of the Amazon Web Services account that contains the knowledge base.
- Parameters:
awsAccountId- The ID of the Amazon Web Services account that contains the knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBaseId
The unique identifier for the knowledge base.
- Parameters:
knowledgeBaseId- The unique identifier for the knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleId
A unique identifier for the knowledge base refresh schedule.
- Parameters:
scheduleId- A unique identifier for the knowledge base refresh schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleFrequency
CreateKnowledgeBaseRefreshScheduleRequest.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 CreateKnowledgeBaseRefreshScheduleRequest.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. 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theENABLEDstate. 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 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.- Parameters:
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 theENABLEDstate. 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:
-
overrideConfiguration
CreateKnowledgeBaseRefreshScheduleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateKnowledgeBaseRefreshScheduleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-