Class ListProductsRequest.Builder (2.24.0) 

public static final class ListProductsRequest.Builder extends GeneratedMessageV3.Builder<ListProductsRequest.Builder> implements ListProductsRequestOrBuilder

Request message for ProductService.ListProducts method.

Protobuf type google.cloud.retail.v2.ListProductsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListProductsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

build()

public ListProductsRequest build()
Returns
TypeDescription
ListProductsRequest

buildPartial()

public ListProductsRequest buildPartial()
Returns
TypeDescription
ListProductsRequest

clear()

public ListProductsRequest.Builder clear()
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

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 is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"

  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

string filter = 4;

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

clearPageSize()

public ListProductsRequest.Builder clearPageSize()

Maximum number of Products 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
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

clearPageToken()

public ListProductsRequest.Builder clearPageToken()

A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
ListProductsRequest.Builder

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 Products 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
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

clearReadMask()

public ListProductsRequest.Builder clearReadMask()

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
ListProductsRequest.Builder

clone()

public ListProductsRequest.Builder clone()
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListProductsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"

  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"

  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Maximum number of Products 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
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

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 Products 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
TypeDescription
String

The parent.

getParentBytes()

public 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 Products 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
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListProductsRequest other)

public ListProductsRequest.Builder mergeFrom(ListProductsRequest other)
Parameter
NameDescription
otherListProductsRequest
Returns
TypeDescription
ListProductsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProductsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListProductsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListProductsRequest.Builder mergeReadMask(FieldMask value)

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. 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;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListProductsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

setFilter(String value)

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 is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"

  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListProductsRequest.Builder setFilterBytes(ByteString value)

A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset.
  • List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id"
  • List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id"

  • List Products 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 Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListProductsRequest.Builder setPageSize(int value)

Maximum number of Products 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;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListProductsRequest.Builder setPageToken(String value)

A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListProductsRequest.Builder setPageTokenBytes(ByteString value)

A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setParent(String value)

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 Products 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) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListProductsRequest.Builder setParentBytes(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 Products 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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListProductsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListProductsRequest.Builder setReadMask(FieldMask value)

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. 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;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListProductsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListProductsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

  • Product.name
  • Product.id
  • Product.title
  • Product.uri
  • Product.images
  • Product.price_info
  • Product.brands

    If "*" is provided, all fields are returned. 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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListProductsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListProductsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListProductsRequest.Builder
Overrides