Class ProductSearchResults (2.0.29)

public final class ProductSearchResults extends GeneratedMessageV3 implements ProductSearchResultsOrBuilder

Results for a product search request.

Protobuf type google.cloud.vision.v1p3beta1.ProductSearchResults

Static Fields

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

INDEX_TIME_FIELD_NUMBER

public static final int INDEX_TIME_FIELD_NUMBER
Field Value
Type Description
int

PRODUCTS_FIELD_NUMBER

public static final int PRODUCTS_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_CATEGORY_FIELD_NUMBER

public static final int PRODUCT_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProductSearchResults getDefaultInstance()
Returns
Type Description
ProductSearchResults

getDescriptor()

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

newBuilder()

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

newBuilder(ProductSearchResults prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCategory()

public ProductSearchCategory getCategory()

Product category. [Deprecated] Use product_category.

.google.cloud.vision.v1p3beta1.ProductSearchCategory category = 1;

Returns
Type Description
ProductSearchCategory

The category.

getCategoryValue()

public int getCategoryValue()

Product category. [Deprecated] Use product_category.

.google.cloud.vision.v1p3beta1.ProductSearchCategory category = 1;

Returns
Type Description
int

The enum numeric value on the wire for category.

getDefaultInstanceForType()

public ProductSearchResults getDefaultInstanceForType()
Returns
Type Description
ProductSearchResults

getIndexTime()

public Timestamp getIndexTime()

Timestamp of the index which provided these results. Changes made after this time are not reflected in the current results.

.google.protobuf.Timestamp index_time = 2;

Returns
Type Description
Timestamp

The indexTime.

getIndexTimeOrBuilder()

public TimestampOrBuilder getIndexTimeOrBuilder()

Timestamp of the index which provided these results. Changes made after this time are not reflected in the current results.

.google.protobuf.Timestamp index_time = 2;

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getProductCategory()

public String getProductCategory()

Product category. Supported values are bag and shoe. [Deprecated] product_category is provided in each Product.

string product_category = 4;

Returns
Type Description
String

The productCategory.

getProductCategoryBytes()

public ByteString getProductCategoryBytes()

Product category. Supported values are bag and shoe. [Deprecated] product_category is provided in each Product.

string product_category = 4;

Returns
Type Description
ByteString

The bytes for productCategory.

getProducts(int index)

public ProductSearchResults.ProductInfo getProducts(int index)

List of detected products.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.ProductInfo products = 3;

Parameter
Name Description
index int
Returns
Type Description
ProductSearchResults.ProductInfo

getProductsCount()

public int getProductsCount()

List of detected products.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.ProductInfo products = 3;

Returns
Type Description
int

getProductsList()

public List<ProductSearchResults.ProductInfo> getProductsList()

List of detected products.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.ProductInfo products = 3;

Returns
Type Description
List<ProductInfo>

getProductsOrBuilder(int index)

public ProductSearchResults.ProductInfoOrBuilder getProductsOrBuilder(int index)

List of detected products.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.ProductInfo products = 3;

Parameter
Name Description
index int
Returns
Type Description
ProductSearchResults.ProductInfoOrBuilder

getProductsOrBuilderList()

public List<? extends ProductSearchResults.ProductInfoOrBuilder> getProductsOrBuilderList()

List of detected products.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.ProductInfo products = 3;

Returns
Type Description
List<? extends com.google.cloud.vision.v1p3beta1.ProductSearchResults.ProductInfoOrBuilder>

getResults(int index)

public ProductSearchResults.Result getResults(int index)

List of results, one for each product match.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.Result results = 5;

Parameter
Name Description
index int
Returns
Type Description
ProductSearchResults.Result

getResultsCount()

public int getResultsCount()

List of results, one for each product match.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.Result results = 5;

Returns
Type Description
int

getResultsList()

public List<ProductSearchResults.Result> getResultsList()

List of results, one for each product match.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.Result results = 5;

Returns
Type Description
List<Result>

getResultsOrBuilder(int index)

public ProductSearchResults.ResultOrBuilder getResultsOrBuilder(int index)

List of results, one for each product match.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.Result results = 5;

Parameter
Name Description
index int
Returns
Type Description
ProductSearchResults.ResultOrBuilder

getResultsOrBuilderList()

public List<? extends ProductSearchResults.ResultOrBuilder> getResultsOrBuilderList()

List of results, one for each product match.

repeated .google.cloud.vision.v1p3beta1.ProductSearchResults.Result results = 5;

Returns
Type Description
List<? extends com.google.cloud.vision.v1p3beta1.ProductSearchResults.ResultOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasIndexTime()

public boolean hasIndexTime()

Timestamp of the index which provided these results. Changes made after this time are not reflected in the current results.

.google.protobuf.Timestamp index_time = 2;

Returns
Type Description
boolean

Whether the indexTime field is set.

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 ProductSearchResults.Builder newBuilderForType()
Returns
Type Description
ProductSearchResults.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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