Interface SearchJobsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SearchJobsRequest.Builder,SearchJobsRequest>,DeadlineRequest.Builder,SdkBuilder<SearchJobsRequest.Builder,SearchJobsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- SearchJobsRequest
public static interface SearchJobsRequest.Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<SearchJobsRequest.Builder,SearchJobsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SearchJobsRequest.BuilderfarmId(String farmId)The farm ID of the job.default SearchJobsRequest.BuilderfilterExpressions(Consumer<SearchGroupedFilterExpressions.Builder> filterExpressions)The filter expression,ANDorOR, to use when searching among a group of search strings in a resource.SearchJobsRequest.BuilderfilterExpressions(SearchGroupedFilterExpressions filterExpressions)The filter expression,ANDorOR, to use when searching among a group of search strings in a resource.SearchJobsRequest.BuilderitemOffset(Integer itemOffset)Defines how far into the scrollable list to start the return of results.SearchJobsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)SearchJobsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)SearchJobsRequest.BuilderpageSize(Integer pageSize)Specifies the number of items per page for the resource.SearchJobsRequest.BuilderqueueIds(String... queueIds)The queue ID to use in the job search.SearchJobsRequest.BuilderqueueIds(Collection<String> queueIds)The queue ID to use in the job search.SearchJobsRequest.BuildersortExpressions(Collection<SearchSortExpression> sortExpressions)The search terms for a resource.SearchJobsRequest.BuildersortExpressions(Consumer<SearchSortExpression.Builder>... sortExpressions)The search terms for a resource.SearchJobsRequest.BuildersortExpressions(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 Detail
-
farmId
SearchJobsRequest.Builder farmId(String 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
SearchJobsRequest.Builder filterExpressions(SearchGroupedFilterExpressions filterExpressions)
The filter expression,
ANDorOR, 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,ANDorOR, 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,
ANDorOR, 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.Builderavoiding the need to create one manually viaSearchGroupedFilterExpressions.builder().When the
Consumercompletes,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:
filterExpressions(SearchGroupedFilterExpressions)
-
itemOffset
SearchJobsRequest.Builder itemOffset(Integer 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
SearchJobsRequest.Builder pageSize(Integer 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
SearchJobsRequest.Builder queueIds(Collection<String> 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
SearchJobsRequest.Builder queueIds(String... 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
SearchJobsRequest.Builder sortExpressions(Collection<SearchSortExpression> 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(SearchSortExpression... 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.Builderavoiding the need to create one manually viaSearchSortExpression.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#sortExpressions(List.) - 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:
#sortExpressions(java.util.Collection)
-
overrideConfiguration
SearchJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
SearchJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-