Class ListProductsResponse.Builder (2.48.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

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

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

clearField(Descriptors.FieldDescriptor field)

public ListProductsResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListProductsResponse.Builder
Overrides

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

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

getDefaultInstanceForType()

public ListProductsResponse getDefaultInstanceForType()
Returns
Type Description
ListProductsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

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
int

The totalSize.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListProductsResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListProductsResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListProductsResponse.Builder
Overrides

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

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

setTotalSize(int value)

public ListProductsResponse.Builder setTotalSize(int value)

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;

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