Interface SearchJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchJobsRequest.Builder,SearchJobsRequest>, DeadlineRequest.Builder, SdkBuilder<SearchJobsRequest.Builder,SearchJobsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchJobsRequest

@Mutable
@NotThreadSafe
public static interface SearchJobsRequest.Builder
extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<SearchJobsRequest.Builder,SearchJobsRequest>

Method Summary

Modifier and Type	Method	Description
SearchJobsRequest.Builder	farmId(String farmId)	The farm ID of the job.
default SearchJobsRequest.Builder	filterExpressions(Consumer<SearchGroupedFilterExpressions.Builder> filterExpressions)	The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
SearchJobsRequest.Builder	filterExpressions(SearchGroupedFilterExpressions filterExpressions)	The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
SearchJobsRequest.Builder	itemOffset(Integer itemOffset)	Defines how far into the scrollable list to start the return of results.
SearchJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchJobsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SearchJobsRequest.Builder	pageSize(Integer pageSize)	Specifies the number of items per page for the resource.
SearchJobsRequest.Builder	queueIds(String... queueIds)	The queue ID to use in the job search.
SearchJobsRequest.Builder	queueIds(Collection<String> queueIds)	The queue ID to use in the job search.
SearchJobsRequest.Builder	sortExpressions(Collection<SearchSortExpression> sortExpressions)	The search terms for a resource.
SearchJobsRequest.Builder	sortExpressions(Consumer<SearchSortExpression.Builder>... sortExpressions)	The search terms for a resource.
SearchJobsRequest.Builder	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, sdkFieldNameToField, sdkFields

Method Details

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.

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.

filterExpressions

SearchJobsRequest.Builder filterExpressions(SearchGroupedFilterExpressions filterExpressions)

The filter expression, AND or OR, 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 or OR, 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 or OR, 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 via SearchGroupedFilterExpressions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterExpressions(SearchGroupedFilterExpressions).

Parameters:

filterExpressions - a consumer that will call methods on SearchGroupedFilterExpressions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filterExpressions(SearchGroupedFilterExpressions)

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 the SearchSortExpression.Builder avoiding the need to create one manually via SearchSortExpression.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortExpressions(List<SearchSortExpression>).

Parameters:

sortExpressions - a consumer that will call methods on SearchSortExpression.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sortExpressions(java.util.Collection<SearchSortExpression>)

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.

overrideConfiguration

SearchJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.