Interface ListKeyPhrasesDetectionJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<ListKeyPhrasesDetectionJobsRequest.Builder,ListKeyPhrasesDetectionJobsRequest>, SdkBuilder<ListKeyPhrasesDetectionJobsRequest.Builder,ListKeyPhrasesDetectionJobsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListKeyPhrasesDetectionJobsRequest

public static interface ListKeyPhrasesDetectionJobsRequest.Builder
extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<ListKeyPhrasesDetectionJobsRequest.Builder,ListKeyPhrasesDetectionJobsRequest>

Method Summary

Modifier and Type	Method	Description
default ListKeyPhrasesDetectionJobsRequest.Builder	filter(Consumer<KeyPhrasesDetectionJobFilter.Builder> filter)	Filters the jobs that are returned.
ListKeyPhrasesDetectionJobsRequest.Builder	filter(KeyPhrasesDetectionJobFilter filter)	Filters the jobs that are returned.
ListKeyPhrasesDetectionJobsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in each page.
ListKeyPhrasesDetectionJobsRequest.Builder	nextToken(String nextToken)	Identifies the next page of results to return.
ListKeyPhrasesDetectionJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListKeyPhrasesDetectionJobsRequest.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.services.comprehend.model.ComprehendRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

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

ListKeyPhrasesDetectionJobsRequest.Builder filter(KeyPhrasesDetectionJobFilter filter)

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

Parameters:

filter - Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

Returns:

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

filter

default ListKeyPhrasesDetectionJobsRequest.Builder filter(Consumer<KeyPhrasesDetectionJobFilter.Builder> filter)

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

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

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

Parameters:

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

Returns:

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

See Also:

• filter(KeyPhrasesDetectionJobFilter)

nextToken

ListKeyPhrasesDetectionJobsRequest.Builder nextToken(String nextToken)

Identifies the next page of results to return.

Parameters:

nextToken - Identifies the next page of results to return.

Returns:

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

maxResults

ListKeyPhrasesDetectionJobsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in each page. The default is 100.

Parameters:

maxResults - The maximum number of results to return in each page. The default is 100.

Returns:

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

overrideConfiguration

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

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