Interface ListIngestionJobsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BedrockAgentRequest.Builder
,Buildable
,CopyableBuilder<ListIngestionJobsRequest.Builder,
,ListIngestionJobsRequest> SdkBuilder<ListIngestionJobsRequest.Builder,
,ListIngestionJobsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListIngestionJobsRequest
-
Method Summary
Modifier and TypeMethodDescriptiondataSourceId
(String dataSourceId) The unique identifier of the data source for which to return ingestion jobs.filters
(Collection<IngestionJobFilter> filters) Contains a definition of a filter for which to filter the results.filters
(Consumer<IngestionJobFilter.Builder>... filters) Contains a definition of a filter for which to filter the results.filters
(IngestionJobFilter... filters) Contains a definition of a filter for which to filter the results.knowledgeBaseId
(String knowledgeBaseId) The unique identifier of the knowledge base for which to return ingestion jobs.maxResults
(Integer maxResults) The maximum number of results to return in the response.If the total number of results is greater than themaxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default ListIngestionJobsRequest.Builder
sortBy
(Consumer<IngestionJobSortBy.Builder> sortBy) Contains details about how to sort the results.sortBy
(IngestionJobSortBy sortBy) Contains details about how to sort the results.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
dataSourceId
The unique identifier of the data source for which to return ingestion jobs.
- Parameters:
dataSourceId
- The unique identifier of the data source for which to return ingestion jobs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Contains a definition of a filter for which to filter the results.
- Parameters:
filters
- Contains a definition of a filter for which to filter the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Contains a definition of a filter for which to filter the results.
- Parameters:
filters
- Contains a definition of a filter for which to filter the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Contains a definition of a filter for which to filter the results.
This is a convenience method that creates an instance of theIngestionJobFilter.Builder
avoiding the need to create one manually viaIngestionJobFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<IngestionJobFilter>)
.- Parameters:
filters
- a consumer that will call methods onIngestionJobFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
knowledgeBaseId
The unique identifier of the knowledge base for which to return ingestion jobs.
- Parameters:
knowledgeBaseId
- The unique identifier of the knowledge base for which to return ingestion jobs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.- Parameters:
maxResults
- The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in thenextToken
field when making another request to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.- Parameters:
nextToken
- If the total number of results is greater than themaxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
Contains details about how to sort the results.
- Parameters:
sortBy
- Contains details about how to sort the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
Contains details about how to sort the results.
This is a convenience method that creates an instance of theIngestionJobSortBy.Builder
avoiding the need to create one manually viaIngestionJobSortBy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortBy(IngestionJobSortBy)
.- Parameters:
sortBy
- a consumer that will call methods onIngestionJobSortBy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListIngestionJobsRequest.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
ListIngestionJobsRequest.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.
-