Interface SearchJobsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchJobsRequest.Builder,
,SearchJobsRequest> DeadlineRequest.Builder
,SdkBuilder<SearchJobsRequest.Builder,
,SearchJobsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchJobsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe farm ID of the job.default SearchJobsRequest.Builder
filterExpressions
(Consumer<SearchGroupedFilterExpressions.Builder> filterExpressions) The filter expression,AND
orOR
, to use when searching among a group of search strings in a resource.filterExpressions
(SearchGroupedFilterExpressions filterExpressions) The filter expression,AND
orOR
, to use when searching among a group of search strings in a resource.itemOffset
(Integer itemOffset) Defines how far into the scrollable list to start the return of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Specifies the number of items per page for the resource.The queue ID to use in the job search.queueIds
(Collection<String> queueIds) The queue ID to use in the job search.sortExpressions
(Collection<SearchSortExpression> sortExpressions) The search terms for a resource.sortExpressions
(Consumer<SearchSortExpression.Builder>... sortExpressions) The search terms for a resource.sortExpressions
(SearchSortExpression... sortExpressions) The search terms for a resource.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.deadline.model.DeadlineRequest.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
-
farmId
The farm ID of the job.
- Parameters:
farmId
- The farm ID of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterExpressions
The filter expression,
AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
()
.- Parameters:
filterExpressions
- The filter expression,AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
()
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterExpressions
default SearchJobsRequest.Builder filterExpressions(Consumer<SearchGroupedFilterExpressions.Builder> filterExpressions) The filter expression,
AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
This is a convenience method that creates an instance of the()
.SearchGroupedFilterExpressions.Builder
avoiding the need to create one manually viaSearchGroupedFilterExpressions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilterExpressions(SearchGroupedFilterExpressions)
.- Parameters:
filterExpressions
- a consumer that will call methods onSearchGroupedFilterExpressions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
itemOffset
Defines how far into the scrollable list to start the return of results.
- Parameters:
itemOffset
- Defines how far into the scrollable list to start the return of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pageSize
Specifies the number of items per page for the resource.
- Parameters:
pageSize
- Specifies the number of items per page for the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queueIds
The queue ID to use in the job search.
- Parameters:
queueIds
- The queue ID to use in the job search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queueIds
The queue ID to use in the job search.
- Parameters:
queueIds
- The queue ID to use in the job search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortExpressions
The search terms for a resource.
- Parameters:
sortExpressions
- The search terms for a resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortExpressions
The search terms for a resource.
- Parameters:
sortExpressions
- The search terms for a resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortExpressions
SearchJobsRequest.Builder sortExpressions(Consumer<SearchSortExpression.Builder>... sortExpressions) The search terms for a resource.
This is a convenience method that creates an instance of theSearchSortExpression.Builder
avoiding the need to create one manually viaSearchSortExpression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortExpressions(List<SearchSortExpression>)
.- Parameters:
sortExpressions
- a consumer that will call methods onSearchSortExpression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-