Interface DescribePackagesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribePackagesRequest.Builder,DescribePackagesRequest>, OpenSearchRequest.Builder, SdkBuilder<DescribePackagesRequest.Builder,DescribePackagesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribePackagesRequest

public static interface DescribePackagesRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<DescribePackagesRequest.Builder,DescribePackagesRequest>

Method Summary

Modifier and Type	Method	Description
DescribePackagesRequest.Builder	filters(Collection<DescribePackagesFilter> filters)	Only returns packages that match the DescribePackagesFilterList values.
DescribePackagesRequest.Builder	filters(Consumer<DescribePackagesFilter.Builder>... filters)	Only returns packages that match the DescribePackagesFilterList values.
DescribePackagesRequest.Builder	filters(DescribePackagesFilter... filters)	Only returns packages that match the DescribePackagesFilterList values.
DescribePackagesRequest.Builder	maxResults(Integer maxResults)	An optional parameter that specifies the maximum number of results to return.
DescribePackagesRequest.Builder	nextToken(String nextToken)	If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
DescribePackagesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribePackagesRequest.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.opensearch.model.OpenSearchRequest.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 Details

filters

DescribePackagesRequest.Builder filters(Collection<DescribePackagesFilter> filters)

Only returns packages that match the DescribePackagesFilterList values.

Parameters:

filters - Only returns packages that match the DescribePackagesFilterList values.

Returns:

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

filters

DescribePackagesRequest.Builder filters(DescribePackagesFilter... filters)

Only returns packages that match the DescribePackagesFilterList values.

Parameters:

filters - Only returns packages that match the DescribePackagesFilterList values.

Returns:

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

filters

DescribePackagesRequest.Builder filters(Consumer<DescribePackagesFilter.Builder>... filters)

Only returns packages that match the DescribePackagesFilterList values.

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

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

Parameters:

filters - a consumer that will call methods on DescribePackagesFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<DescribePackagesFilter>)

maxResults

DescribePackagesRequest.Builder maxResults(Integer maxResults)

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Parameters:

maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Returns:

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

nextToken

DescribePackagesRequest.Builder nextToken(String nextToken)

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Parameters:

nextToken - If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Returns:

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

overrideConfiguration

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

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