Package com.google.cloud.retail.v2

Class 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.GeneratedMessageV3.Builder<ListProductsRequest.Builder>
implements ListProductsRequestOrBuilder
     Request message for
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 method.
    Protobuf type google.cloud.retail.v2.ListProductsRequest

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

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

      • setField

        public ListProductsRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>

      • clearField

        public ListProductsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>

      • clearOneof

        public ListProductsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>

      • setRepeatedField

        public ListProductsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>

      • addRepeatedField

        public ListProductsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.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>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.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.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.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.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.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.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.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.v2.ListProductsResponse.next_page_token],
 received from a previous
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [ProductService.ListProducts][google.cloud.retail.v2.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.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.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.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.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.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.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.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.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.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.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.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.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.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.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.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.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.v2.ListProductsRequest.filter] is unset.
 * List [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s sharing the same
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   [Product][google.cloud.retail.v2.Product]. For example:
     `primary_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.Product]s bundled in a
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.Product].
   For example:
     `collection_product_id = "some_product_id"`
 * List [Product][google.cloud.retail.v2.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.v2.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2.Product] or
 [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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.v2.Product] to return in the
 responses. If not set or empty, the following fields are returned:

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

 If "*" is provided, all fields are returned.
 [Product.name][google.cloud.retail.v2.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

      • setUnknownFields

        public final ListProductsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>

      • mergeUnknownFields

        public final ListProductsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>