Class ListProductsRequest.Builder (2.13.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.v2alpha.ListProductsRequest

Inheritance

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

Implements

ListProductsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListProductsRequest build()

Returns

Type	Description
`ListProductsRequest`

buildPartial()

public ListProductsRequest buildPartial()

Returns

Type	Description
`ListProductsRequest`

clear()

public ListProductsRequest.Builder clear()

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
`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

Type	Description
`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

Type	Description
`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

Type	Description
`ListProductsRequest.Builder`

clearRequireTotalSize()

public ListProductsRequest.Builder clearRequireTotalSize()

If true and page_token is empty, 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

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

clone()

public ListProductsRequest.Builder clone()

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListProductsRequest getDefaultInstanceForType()

Returns

Type	Description
`ListProductsRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
`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

Type	Description
`ByteString`	The bytes for filter.

getPageSize()

public int getPageSize()

int32 page_size = 2;

Returns

Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

string page_token = 3;

Returns

Type	Description
`String`	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

string page_token = 3;

Returns

Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public String getParent()

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
`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

Type	Description
`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

Type	Description
`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

Type	Description
`FieldMaskOrBuilder`

getRequireTotalSize()

public boolean getRequireTotalSize()

If true and page_token is empty, 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

Type	Description
`boolean`	The requireTotalSize.

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

Type	Description
`boolean`	Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListProductsRequest other)

public ListProductsRequest.Builder mergeFrom(ListProductsRequest other)

Parameter

Name	Description
`other`	`ListProductsRequest`

Returns

Type	Description
`ListProductsRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public ListProductsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Name	Description
`value`	`FieldMask`

Returns

Type	Description
`ListProductsRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
`value`	`String` The filter to set.

Returns

Type	Description
`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

Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

setPageSize(int value)

public ListProductsRequest.Builder setPageSize(int value)

int32 page_size = 2;

Parameter

Name	Description
`value`	`int` The pageSize to set.

Returns

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

setPageToken(String value)

public ListProductsRequest.Builder setPageToken(String value)

string page_token = 3;

Parameter

Name	Description
`value`	`String` The pageToken to set.

Returns

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListProductsRequest.Builder setPageTokenBytes(ByteString value)

string page_token = 3;

Parameter

Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

setParent(String value)

public ListProductsRequest.Builder setParent(String value)

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
`value`	`String` The parent to set.

Returns

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public ListProductsRequest.Builder setParentBytes(ByteString value)

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns

Type	Description
`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

Name	Description
`value`	`FieldMask`

Returns

Type	Description
`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

Name	Description
`builderForValue`	`Builder`

Returns

Type	Description
`ListProductsRequest.Builder`

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

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

Parameters

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequireTotalSize(boolean value)

public ListProductsRequest.Builder setRequireTotalSize(boolean value)

If true and page_token is empty, 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;

Parameter

Name	Description
`value`	`boolean` The requireTotalSize to set.

Returns

Type	Description
`ListProductsRequest.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`ListProductsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)