Class ListProductsResponse (2.50.0) 

public final class ListProductsResponse extends GeneratedMessageV3 implements ListProductsResponseOrBuilder

Response message for ProductService.ListProducts method.

Protobuf type google.cloud.retail.v2alpha.ListProductsResponse

Inheritance

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

Static Fields

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PRODUCTS_FIELD_NUMBER

public static final int PRODUCTS_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListProductsResponse getDefaultInstance()
Returns
Type Description
ListProductsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListProductsResponse.Builder newBuilder()
Returns
Type Description
ListProductsResponse.Builder

newBuilder(ListProductsResponse prototype)

public static ListProductsResponse.Builder newBuilder(ListProductsResponse prototype)
Parameter
Name Description
prototype ListProductsResponse
Returns
Type Description
ListProductsResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListProductsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListProductsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListProductsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListProductsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListProductsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListProductsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListProductsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListProductsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListProductsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListProductsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListProductsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListProductsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListProductsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListProductsResponse> parser()
Returns
Type Description
Parser<ListProductsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListProductsResponse getDefaultInstanceForType()
Returns
Type Description
ListProductsResponse

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.

getParserForType()

public Parser<ListProductsResponse> getParserForType()
Returns
Type Description
Parser<ListProductsResponse>
Overrides

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

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListProductsResponse.Builder newBuilderForType()
Returns
Type Description
ListProductsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListProductsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListProductsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListProductsResponse.Builder toBuilder()
Returns
Type Description
ListProductsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException