Interface SearchJobsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BraketRequest.Builder
,Buildable
,CopyableBuilder<SearchJobsRequest.Builder,
,SearchJobsRequest> SdkBuilder<SearchJobsRequest.Builder,
,SearchJobsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchJobsRequest
public static interface SearchJobsRequest.Builder
extends BraketRequest.Builder, SdkPojo, CopyableBuilder<SearchJobsRequest.Builder,SearchJobsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<SearchJobsFilter> filters) The filter values to use when searching for a job.filters
(Consumer<SearchJobsFilter.Builder>... filters) The filter values to use when searching for a job.filters
(SearchJobsFilter... filters) The filter values to use when searching for a job.maxResults
(Integer maxResults) The maximum number of results to return in the response.A token used for pagination of results returned in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.braket.model.BraketRequest.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
-
filters
The filter values to use when searching for a job.
- Parameters:
filters
- The filter values to use when searching for a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filter values to use when searching for a job.
- Parameters:
filters
- The filter values to use when searching for a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filter values to use when searching for a job.
This is a convenience method that creates an instance of theSearchJobsFilter.Builder
avoiding the need to create one manually viaSearchJobsFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<SearchJobsFilter>)
.- Parameters:
filters
- a consumer that will call methods onSearchJobsFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The maximum number of results to return in the response.
- Parameters:
maxResults
- The maximum number of results to return in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
- Parameters:
nextToken
- A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SearchJobsRequest.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
SearchJobsRequest.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.
-