Interface SearchStepsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchStepsRequest

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

Method Summary

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

SearchStepsRequest.Builder farmId(String farmId)

The farm ID to use for the step search.

Parameters:

farmId - The farm ID to use for the step search.

Returns:

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

queueIds

SearchStepsRequest.Builder queueIds(Collection<String> queueIds)

The queue IDs in the step search.

Parameters:

queueIds - The queue IDs in the step search.

Returns:

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

queueIds

SearchStepsRequest.Builder queueIds(String... queueIds)

The queue IDs in the step search.

Parameters:

queueIds - The queue IDs in the step search.

Returns:

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

jobId

SearchStepsRequest.Builder jobId(String jobId)

The job ID to use in the step search.

Parameters:

jobId - The job ID to use in the step search.

Returns:

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

filterExpressions

SearchStepsRequest.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 SearchStepsRequest.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

SearchStepsRequest.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

SearchStepsRequest.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

SearchStepsRequest.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

SearchStepsRequest.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

SearchStepsRequest.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

SearchStepsRequest.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

SearchStepsRequest.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.