Interface ListJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>, LocationRequest.Builder, SdkBuilder<ListJobsRequest.Builder,ListJobsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListJobsRequest

@Mutable
@NotThreadSafe
public static interface ListJobsRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Method Summary

Modifier and Type	Method	Description
default ListJobsRequest.Builder	filter(Consumer<JobsFilter.Builder> filter)	An optional structure containing criteria by which to filter job results.
ListJobsRequest.Builder	filter(JobsFilter filter)	An optional structure containing criteria by which to filter job results.
ListJobsRequest.Builder	maxResults(Integer maxResults)	Maximum number of jobs to return.
ListJobsRequest.Builder	nextToken(String nextToken)	The pagination token specifying which page of results to return in the response.
ListJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListJobsRequest.Builder	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.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.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

filter

ListJobsRequest.Builder filter(JobsFilter filter)

An optional structure containing criteria by which to filter job results.

Parameters:

filter - An optional structure containing criteria by which to filter job results.

Returns:

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

filter

default ListJobsRequest.Builder filter(Consumer<JobsFilter.Builder> filter)

An optional structure containing criteria by which to filter job results.

This is a convenience method that creates an instance of the JobsFilter.Builder avoiding the need to create one manually via JobsFilter.builder().

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

Parameters:

filter - a consumer that will call methods on JobsFilter.Builder

Returns:

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

See Also:

• filter(JobsFilter)

maxResults

ListJobsRequest.Builder maxResults(Integer maxResults)

Maximum number of jobs to return.

Parameters:

maxResults - Maximum number of jobs to return.

Returns:

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

nextToken

ListJobsRequest.Builder nextToken(String nextToken)

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Parameters:

nextToken - The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Returns:

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

overrideConfiguration

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

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