software.amazon.awssdk.services.marketplacecatalog.model

Interface ListEntitiesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>, MarketplaceCatalogRequest.Builder, SdkBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListEntitiesRequest

public static interface ListEntitiesRequest.Builder
extends MarketplaceCatalogRequest.Builder, SdkPojo, CopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>

Method Summary

Modifier and Type	Method and Description
ListEntitiesRequest.Builder	catalog(String catalog) The catalog related to the request.
ListEntitiesRequest.Builder	entityType(String entityType) The type of entities to retrieve.
ListEntitiesRequest.Builder	filterList(Collection<Filter> filterList) An array of filter objects.
ListEntitiesRequest.Builder	filterList(Consumer<Filter.Builder>... filterList) An array of filter objects.
ListEntitiesRequest.Builder	filterList(Filter... filterList) An array of filter objects.
ListEntitiesRequest.Builder	maxResults(Integer maxResults) Specifies the upper limit of the elements on a single page.
ListEntitiesRequest.Builder	nextToken(String nextToken) The value of the next token, if it exists.
ListEntitiesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListEntitiesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListEntitiesRequest.Builder	ownershipType(OwnershipType ownershipType) Sets the value of the OwnershipType property for this object.
ListEntitiesRequest.Builder	ownershipType(String ownershipType) Sets the value of the OwnershipType property for this object.
default ListEntitiesRequest.Builder	sort(Consumer<Sort.Builder> sort) An object that contains two attributes, SortBy and SortOrder.
ListEntitiesRequest.Builder	sort(Sort sort) An object that contains two attributes, SortBy and SortOrder.

Methods inherited from interface software.amazon.awssdk.services.marketplacecatalog.model.MarketplaceCatalogRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

catalog

ListEntitiesRequest.Builder catalog(String catalog)

The catalog related to the request. Fixed value: AWSMarketplace

Parameters:

catalog - The catalog related to the request. Fixed value: AWSMarketplace

Returns:

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

entityType

ListEntitiesRequest.Builder entityType(String entityType)

The type of entities to retrieve.

Parameters:

entityType - The type of entities to retrieve.

Returns:

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

filterList

ListEntitiesRequest.Builder filterList(Collection<Filter> filterList)

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

Parameters:

filterList - An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

Returns:

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

filterList

ListEntitiesRequest.Builder filterList(Filter... filterList)

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

Parameters:

filterList - An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

Returns:

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

filterList

ListEntitiesRequest.Builder filterList(Consumer<Filter.Builder>... filterList)

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filterList(List).

Parameters:

filterList - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

#filterList(java.util.Collection)

sort

ListEntitiesRequest.Builder sort(Sort sort)

An object that contains two attributes, SortBy and SortOrder.

Parameters:

sort - An object that contains two attributes, SortBy and SortOrder.

Returns:

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

sort

default ListEntitiesRequest.Builder sort(Consumer<Sort.Builder> sort)

An object that contains two attributes, SortBy and SortOrder.

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

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

Parameters:

sort - a consumer that will call methods on Sort.Builder

Returns:

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

See Also:

sort(Sort)

nextToken

ListEntitiesRequest.Builder nextToken(String nextToken)

The value of the next token, if it exists. Null if there are no more results.

Parameters:

nextToken - The value of the next token, if it exists. Null if there are no more results.

Returns:

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

maxResults

ListEntitiesRequest.Builder maxResults(Integer maxResults)

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

Parameters:

maxResults - Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

Returns:

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

ownershipType

ListEntitiesRequest.Builder ownershipType(String ownershipType)

Sets the value of the OwnershipType property for this object.

Parameters:

ownershipType - The new value for the OwnershipType property for this object.

Returns:

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

See Also:

OwnershipType, OwnershipType

ownershipType

ListEntitiesRequest.Builder ownershipType(OwnershipType ownershipType)

Sets the value of the OwnershipType property for this object.

Parameters:

ownershipType - The new value for the OwnershipType property for this object.

Returns:

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

See Also:

OwnershipType, OwnershipType

overrideConfiguration

ListEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListEntitiesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder