Interface ListDataSourceSyncJobsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListDataSourceSyncJobsRequest.Builder,
,ListDataSourceSyncJobsRequest> KendraRequest.Builder
,SdkBuilder<ListDataSourceSyncJobsRequest.Builder,
,ListDataSourceSyncJobsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListDataSourceSyncJobsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe identifier of the data source connector.The identifier of the index used with the data source connector.maxResults
(Integer maxResults) The maximum number of synchronization jobs to return in the response.If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.startTimeFilter
(Consumer<TimeRange.Builder> startTimeFilter) When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.startTimeFilter
(TimeRange startTimeFilter) When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.statusFilter
(String statusFilter) Only returns synchronization jobs with theStatus
field equal to the specified status.statusFilter
(DataSourceSyncJobStatus statusFilter) Only returns synchronization jobs with theStatus
field equal to the specified status.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
id
The identifier of the data source connector.
- Parameters:
id
- The identifier of the data source connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexId
The identifier of the index used with the data source connector.
- Parameters:
indexId
- The identifier of the index used with the data source connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.
- Parameters:
nextToken
- If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
- Parameters:
maxResults
- The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTimeFilter
When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
- Parameters:
startTimeFilter
- When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTimeFilter
default ListDataSourceSyncJobsRequest.Builder startTimeFilter(Consumer<TimeRange.Builder> startTimeFilter) When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
This is a convenience method that creates an instance of theTimeRange.Builder
avoiding the need to create one manually viaTimeRange.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostartTimeFilter(TimeRange)
.- Parameters:
startTimeFilter
- a consumer that will call methods onTimeRange.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusFilter
Only returns synchronization jobs with the
Status
field equal to the specified status.- Parameters:
statusFilter
- Only returns synchronization jobs with theStatus
field equal to the specified status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusFilter
Only returns synchronization jobs with the
Status
field equal to the specified status.- Parameters:
statusFilter
- Only returns synchronization jobs with theStatus
field equal to the specified status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListDataSourceSyncJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListDataSourceSyncJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-