Package com.google.cloud.retail.v2alpha

Class ListProductsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListProductsRequest.Builder>
com.google.cloud.retail.v2alpha.ListProductsRequest.Builder
All Implemented Interfaces:
ListProductsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListProductsRequest
public static final class ListProductsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListProductsRequest.Builder> implements ListProductsRequestOrBuilder
 Request message for
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]
 method.
Protobuf type google.cloud.retail.v2alpha.ListProductsRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    ListProductsRequest
    build()
     
    ListProductsRequest
    buildPartial()
     
    ListProductsRequest.Builder
    clear()
     
    ListProductsRequest.Builder
    clearFilter()
    A filter to apply on the list results.
    ListProductsRequest.Builder
    clearPageSize()
    Maximum number of [Product][google.cloud.retail.v2alpha.Product]s to return.
    ListProductsRequest.Builder
    clearPageToken()
    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.
    ListProductsRequest.Builder
    clearParent()
    Required.
    ListProductsRequest.Builder
    clearReadMask()
    The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.
    ListProductsRequest.Builder
    clearRequireTotalSize()
    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.
    ListProductsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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.FieldMask.Builder
    getReadMaskBuilder()
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ListProductsRequest.Builder
    mergeFrom(ListProductsRequest other)
     
    ListProductsRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ListProductsRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ListProductsRequest.Builder
    mergeReadMask(com.google.protobuf.FieldMask value)
    The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.
    ListProductsRequest.Builder
    setFilter(String value)
    A filter to apply on the list results.
    ListProductsRequest.Builder
    setFilterBytes(com.google.protobuf.ByteString value)
    A filter to apply on the list results.
    ListProductsRequest.Builder
    setPageSize(int value)
    Maximum number of [Product][google.cloud.retail.v2alpha.Product]s to return.
    ListProductsRequest.Builder
    setPageToken(String value)
    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.
    ListProductsRequest.Builder
    setPageTokenBytes(com.google.protobuf.ByteString value)
    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.
    ListProductsRequest.Builder
    setParent(String value)
    Required.
    ListProductsRequest.Builder
    setParentBytes(com.google.protobuf.ByteString value)
    Required.
    ListProductsRequest.Builder
    setReadMask(com.google.protobuf.FieldMask value)
    The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.
    ListProductsRequest.Builder
    setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)
    The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses.
    ListProductsRequest.Builder
    setRequireTotalSize(boolean value)
    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.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListProductsRequest.Builder>

    • clear

      public ListProductsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListProductsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListProductsRequest.Builder>

    • getDefaultInstanceForType

      public ListProductsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListProductsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListProductsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListProductsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListProductsRequest.Builder>

    • mergeFrom

      public ListProductsRequest.Builder mergeFrom(ListProductsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListProductsRequest.Builder>

    • mergeFrom

      public ListProductsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListProductsRequest.Builder>
      Throws:
      IOException

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ListProductsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListProductsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListProductsRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListProductsRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public ListProductsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface ListProductsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListProductsRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListProductsRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • getPageToken

      public 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;
      Specified by:
      getPageToken in interface ListProductsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface ListProductsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListProductsRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListProductsRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public ListProductsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getFilter

      public 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;
      Specified by:
      getFilter in interface ListProductsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ListProductsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListProductsRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListProductsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ListProductsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • hasReadMask

      public 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;
      Specified by:
      hasReadMask in interface ListProductsRequestOrBuilder
      Returns:
      Whether the readMask field is set.

    • getReadMask

      public 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;
      Specified by:
      getReadMask in interface ListProductsRequestOrBuilder
      Returns:
      The readMask.

    • setReadMask

      public ListProductsRequest.Builder setReadMask(com.google.protobuf.FieldMask value)
       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;

    • setReadMask

      public ListProductsRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)
       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;

    • mergeReadMask

      public ListProductsRequest.Builder mergeReadMask(com.google.protobuf.FieldMask value)
       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;

    • clearReadMask

      public ListProductsRequest.Builder clearReadMask()
       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;

    • getReadMaskBuilder

      public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()
       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;

    • getReadMaskOrBuilder

      public 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;
      Specified by:
      getReadMaskOrBuilder in interface ListProductsRequestOrBuilder

    • getRequireTotalSize

      public 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;
      Specified by:
      getRequireTotalSize in interface ListProductsRequestOrBuilder
      Returns:
      The requireTotalSize.

    • setRequireTotalSize

      public ListProductsRequest.Builder setRequireTotalSize(boolean value)
       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;
      Parameters:
      value - The requireTotalSize to set.
      Returns:
      This builder for chaining.

    • clearRequireTotalSize

      public ListProductsRequest.Builder clearRequireTotalSize()
       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:
      This builder for chaining.