Package software.amazon.awssdk.services.marketplacecatalog.model

Interface ListEntitiesRequest.Builder

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

        Parameters:
        entityType - The type of entities to retrieve. Valid values are: ServerProduct, 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).

        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.

      • 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, OwnershipType

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

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

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