ListProductsRequest.Builder (proto-google-cloud-retail-v2 2.34.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListProductsRequest.Builder>
    - - com.google.cloud.retail.v2.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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListProductsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListProductsRequest`	`build()`
`ListProductsRequest`	`buildPartial()`
`ListProductsRequest.Builder`	`clear()`
`ListProductsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListProductsRequest.Builder`	`clearFilter()` A filter to apply on the list results.
`ListProductsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListProductsRequest.Builder`	`clearPageSize()` Maximum number of [Product][google.cloud.retail.v2.Product]s to return.
`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.
`ListProductsRequest.Builder`	`clearParent()` Required.
`ListProductsRequest.Builder`	`clearReadMask()` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`ListProductsRequest.Builder`	`clone()`
`ListProductsRequest`	`getDefaultInstanceForType()`
`static 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.v2.Product]s to return.
`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.
`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.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.FieldMask`	`getReadMask()` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`com.google.protobuf.FieldMask.Builder`	`getReadMaskBuilder()` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`com.google.protobuf.FieldMaskOrBuilder`	`getReadMaskOrBuilder()` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`boolean`	`hasReadMask()` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListProductsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListProductsRequest.Builder`	`mergeFrom(ListProductsRequest other)`
`ListProductsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListProductsRequest.Builder`	`mergeReadMask(com.google.protobuf.FieldMask value)` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`ListProductsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListProductsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`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.v2.Product]s to return.
`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.
`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.
`ListProductsRequest.Builder`	`setParent(String value)` Required.
`ListProductsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListProductsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`ListProductsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask value)` The fields of [Product][google.cloud.retail.v2.Product] to return in the responses.
`ListProductsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListProductsRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

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>

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