Class ListProductsResponse.Builder (2.3.0)

public static final class ListProductsResponse.Builder extends GeneratedMessageV3.Builder<ListProductsResponse.Builder> implements ListProductsResponseOrBuilder

Response message for ProductService.ListProducts method.

Protobuf type google.cloud.retail.v2alpha.ListProductsResponse

Inheritance

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

Implements

ListProductsResponseOrBuilder

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)

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)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

addAllProducts(Iterable<? extends Product> values)

public ListProductsResponse.Builder addAllProducts(Iterable<? extends Product> values)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloud.retail.v2alpha.Product>`

Returns

Type	Description
ListProductsResponse.Builder

addProducts(Product value)

public ListProductsResponse.Builder addProducts(Product value)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
value	`Product`

Returns

Type	Description
ListProductsResponse.Builder

addProducts(Product.Builder builderForValue)

public ListProductsResponse.Builder addProducts(Product.Builder builderForValue)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
builderForValue	`Product.Builder`

Returns

Type	Description
ListProductsResponse.Builder

addProducts(int index, Product value)

public ListProductsResponse.Builder addProducts(int index, Product value)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameters

Name	Description
index	`int`
value	`Product`

Returns

Type	Description
ListProductsResponse.Builder

addProducts(int index, Product.Builder builderForValue)

public ListProductsResponse.Builder addProducts(int index, Product.Builder builderForValue)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameters

Name	Description
index	`int`
builderForValue	`Product.Builder`

Returns

Type	Description
ListProductsResponse.Builder

addProductsBuilder()

public Product.Builder addProductsBuilder()

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Returns

Type	Description
Product.Builder

addProductsBuilder(int index)

public Product.Builder addProductsBuilder(int index)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Product.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

build()

public ListProductsResponse build()

Returns

Type	Description
ListProductsResponse

buildPartial()

public ListProductsResponse buildPartial()

Returns

Type	Description
ListProductsResponse

clear()

public ListProductsResponse.Builder clear()

Returns

Type	Description
ListProductsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListProductsResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

clearNextPageToken()

public ListProductsResponse.Builder clearNextPageToken()

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns

Type	Description
ListProductsResponse.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListProductsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

clearProducts()

public ListProductsResponse.Builder clearProducts()

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Returns

Type	Description
ListProductsResponse.Builder

clearTotalSize()

public ListProductsResponse.Builder clearTotalSize()

The total count of matched Products irrespective of pagination. The total number of Products returned by pagination may be less than the total_size that matches. This field is ignored if ListProductsRequest.require_total_size is not set or ListProductsRequest.page_token is not empty.

int32 total_size = 3;

Returns

Type	Description
ListProductsResponse.Builder	This builder for chaining.

clone()

public ListProductsResponse.Builder clone()

Returns

Type	Description
ListProductsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListProductsResponse getDefaultInstanceForType()

Returns

Type	Description
ListProductsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getNextPageToken()

public String getNextPageToken()

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns

Type	Description
String	The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns

Type	Description
ByteString	The bytes for nextPageToken.

getProducts(int index)

public Product getProducts(int index)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Product

getProductsBuilder(int index)

public Product.Builder getProductsBuilder(int index)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Product.Builder

getProductsBuilderList()

public List<Product.Builder> getProductsBuilderList()

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Returns

Type	Description
List<Builder>

getProductsCount()

public int getProductsCount()

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Returns

Type	Description
int

getProductsList()

public List<Product> getProductsList()

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Returns

Type	Description
List<Product>

getProductsOrBuilder(int index)

public ProductOrBuilder getProductsOrBuilder(int index)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ProductOrBuilder

getProductsOrBuilderList()

public List<? extends ProductOrBuilder> getProductsOrBuilderList()

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Returns

Type	Description
List<? extends com.google.cloud.retail.v2alpha.ProductOrBuilder>

getTotalSize()

public int getTotalSize()

int32 total_size = 3;

Returns

Type	Description
int	The totalSize.

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(ListProductsResponse other)

public ListProductsResponse.Builder mergeFrom(ListProductsResponse other)

Parameter

Name	Description
other	`ListProductsResponse`

Returns

Type	Description
ListProductsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListProductsResponse.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

removeProducts(int index)

public ListProductsResponse.Builder removeProducts(int index)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ListProductsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

setNextPageToken(String value)

public ListProductsResponse.Builder setNextPageToken(String value)

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Parameter

Name	Description
value	`String` The nextPageToken to set.

Returns

Type	Description
ListProductsResponse.Builder	This builder for chaining.

setNextPageTokenBytes(ByteString value)

public ListProductsResponse.Builder setNextPageTokenBytes(ByteString value)

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Parameter

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

Returns

Type	Description
ListProductsResponse.Builder	This builder for chaining.

setProducts(int index, Product value)

public ListProductsResponse.Builder setProducts(int index, Product value)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameters

Name	Description
index	`int`
value	`Product`

Returns

Type	Description
ListProductsResponse.Builder

setProducts(int index, Product.Builder builderForValue)

public ListProductsResponse.Builder setProducts(int index, Product.Builder builderForValue)

The Products.

repeated .google.cloud.retail.v2alpha.Product products = 1;

Parameters

Name	Description
index	`int`
builderForValue	`Product.Builder`

Returns

Type	Description
ListProductsResponse.Builder

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

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

Parameters

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

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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

setTotalSize(int value)

public ListProductsResponse.Builder setTotalSize(int value)

int32 total_size = 3;

Parameter

Name	Description
value	`int` The totalSize to set.

Returns

Type	Description
ListProductsResponse.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListProductsResponse.Builder

Overrides

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