Package 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 Details

    • 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. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

      Parameters:
      entityType - The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.
      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<Filter>).

      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:

    • 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:

    • 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)

      Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

      Parameters:
      ownershipType - Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ownershipType

      ListEntitiesRequest.Builder ownershipType(OwnershipType ownershipType)

      Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

      Parameters:
      ownershipType - Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • entityTypeFilters

      ListEntitiesRequest.Builder entityTypeFilters(EntityTypeFilters entityTypeFilters)

      A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

      Parameters:
      entityTypeFilters - A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityTypeFilters

      default ListEntitiesRequest.Builder entityTypeFilters(Consumer<EntityTypeFilters.Builder> entityTypeFilters)

      A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

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

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

      Parameters:
      entityTypeFilters - a consumer that will call methods on EntityTypeFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • entityTypeSort

      ListEntitiesRequest.Builder entityTypeSort(EntityTypeSort entityTypeSort)

      A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

      Parameters:
      entityTypeSort - A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityTypeSort

      default ListEntitiesRequest.Builder entityTypeSort(Consumer<EntityTypeSort.Builder> entityTypeSort)

      A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

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

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

      Parameters:
      entityTypeSort - a consumer that will call methods on EntityTypeSort.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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