Package com.google.cloud.retail.v2alpha

Interface ListProductsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListProductsRequest, ListProductsRequest.Builder
    public interface ListProductsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      A filter to apply on the list results.
      com.google.protobuf.ByteString getFilterBytes()
      A filter to apply on the list results.
      int getPageSize()
      Maximum number of [Product][google.cloud.retail.v2alpha.Product]s to return.
      String getPageToken()
      A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] call.
      com.google.protobuf.ByteString getPageTokenBytes()
      A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] call.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.FieldMask getReadMask()
      The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.
      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
      The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.
      boolean getRequireTotalSize()
      If true and [page_token][google.cloud.retail.v2alpha.ListProductsRequest.page_token] is empty, [ListProductsResponse.total_size][google.cloud.retail.v2alpha.ListProductsResponse.total_size] is set to the total count of matched items irrespective of pagination.
      boolean hasReadMask()
      The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The parent branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
 `default_branch` as the branch ID, to list products under the default
 branch.

 If the caller does not have permission to list
 [Product][google.cloud.retail.v2alpha.Product]s under this branch,
 regardless of whether or not this branch exists, a PERMISSION_DENIED error
 is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The parent branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
 `default_branch` as the branch ID, to list products under the default
 branch.

 If the caller does not have permission to list
 [Product][google.cloud.retail.v2alpha.Product]s under this branch,
 regardless of whether or not this branch exists, a PERMISSION_DENIED error
 is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getPageSize

        int getPageSize()
         Maximum number of [Product][google.cloud.retail.v2alpha.Product]s to
 return. If unspecified, defaults to 100. The maximum allowed value is 1000.
 Values above 1000 will be coerced to 1000.

 If this field is negative, an INVALID_ARGUMENT error is returned.
        int32 page_size = 2;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         A page token
 [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
 must match the call that provided the page token. Otherwise, an
 INVALID_ARGUMENT error is returned.
        string page_token = 3;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         A page token
 [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
 must match the call that provided the page token. Otherwise, an
 INVALID_ARGUMENT error is returned.
        string page_token = 3;
        Returns:
        The bytes for pageToken.

      • getFilter

        String getFilter()
         A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListProductsRequest.filter] is unset.
 * List
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2alpha.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2alpha.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2alpha.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2alpha.Product]s with a partibular
 type. For example:
     `type = "PRIMARY"`
     `type = "VARIANT"`
     `type = "COLLECTION"`

 If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

 If the specified
 [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2alpha.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2alpha.Product] does not exist, a NOT_FOUND
 error is returned.
        string filter = 4;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListProductsRequest.filter] is unset.
 * List
 [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2alpha.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2alpha.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2alpha.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2alpha.Product]s with a partibular
 type. For example:
     `type = "PRIMARY"`
     `type = "VARIANT"`
     `type = "COLLECTION"`

 If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

 If the specified
 [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2alpha.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2alpha.Product] does not exist, a NOT_FOUND
 error is returned.
        string filter = 4;
        Returns:
        The bytes for filter.

      • hasReadMask

        boolean hasReadMask()
         The fields of [Product][google.cloud.retail.v2alpha.Product] to return in
 the responses. If not set or empty, the following fields are returned:

 * [Product.name][google.cloud.retail.v2alpha.Product.name]
 * [Product.id][google.cloud.retail.v2alpha.Product.id]
 * [Product.title][google.cloud.retail.v2alpha.Product.title]
 * [Product.uri][google.cloud.retail.v2alpha.Product.uri]
 * [Product.images][google.cloud.retail.v2alpha.Product.images]
 * [Product.price_info][google.cloud.retail.v2alpha.Product.price_info]
 * [Product.brands][google.cloud.retail.v2alpha.Product.brands]

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2alpha.Product.name] is always returned
 no matter what mask is set.

 If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
 is returned.
        .google.protobuf.FieldMask read_mask = 5;
        Returns:
        Whether the readMask field is set.

      • getReadMask

        com.google.protobuf.FieldMask getReadMask()
         The fields of [Product][google.cloud.retail.v2alpha.Product] to return in
 the responses. If not set or empty, the following fields are returned:

 * [Product.name][google.cloud.retail.v2alpha.Product.name]
 * [Product.id][google.cloud.retail.v2alpha.Product.id]
 * [Product.title][google.cloud.retail.v2alpha.Product.title]
 * [Product.uri][google.cloud.retail.v2alpha.Product.uri]
 * [Product.images][google.cloud.retail.v2alpha.Product.images]
 * [Product.price_info][google.cloud.retail.v2alpha.Product.price_info]
 * [Product.brands][google.cloud.retail.v2alpha.Product.brands]

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2alpha.Product.name] is always returned
 no matter what mask is set.

 If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
 is returned.
        .google.protobuf.FieldMask read_mask = 5;
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         The fields of [Product][google.cloud.retail.v2alpha.Product] to return in
 the responses. If not set or empty, the following fields are returned:

 * [Product.name][google.cloud.retail.v2alpha.Product.name]
 * [Product.id][google.cloud.retail.v2alpha.Product.id]
 * [Product.title][google.cloud.retail.v2alpha.Product.title]
 * [Product.uri][google.cloud.retail.v2alpha.Product.uri]
 * [Product.images][google.cloud.retail.v2alpha.Product.images]
 * [Product.price_info][google.cloud.retail.v2alpha.Product.price_info]
 * [Product.brands][google.cloud.retail.v2alpha.Product.brands]

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2alpha.Product.name] is always returned
 no matter what mask is set.

 If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
 is returned.
        .google.protobuf.FieldMask read_mask = 5;

      • getRequireTotalSize

        boolean getRequireTotalSize()
         If true and
 [page_token][google.cloud.retail.v2alpha.ListProductsRequest.page_token] is
 empty,
 [ListProductsResponse.total_size][google.cloud.retail.v2alpha.ListProductsResponse.total_size]
 is set to the total count of matched items irrespective of pagination.

 Notice that setting this field to true affects the performance.
        bool require_total_size = 6;
        Returns:
        The requireTotalSize.