Class ProductSearchResults (3.73.0) 

public final class ProductSearchResults extends GeneratedMessageV3 implements ProductSearchResultsOrBuilder

Results for a product search request.

Protobuf type google.cloud.vision.v1.ProductSearchResults

Inheritance

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

Static Fields

INDEX_TIME_FIELD_NUMBER

public static final int INDEX_TIME_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_GROUPED_RESULTS_FIELD_NUMBER

public static final int PRODUCT_GROUPED_RESULTS_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

getDefaultInstanceForType()

public ProductSearchResults getDefaultInstanceForType()
Returns
Type Description
ProductSearchResults

getIndexTime()

public Timestamp getIndexTime()

Timestamp of the index which provided these results. Products added to the product set and products removed from the product set 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. Products added to the product set and products removed from the product set 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

getProductGroupedResults(int index)

public ProductSearchResults.GroupedResult getProductGroupedResults(int index)

List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;

Parameter
Name Description
index int
Returns
Type Description
ProductSearchResults.GroupedResult

getProductGroupedResultsCount()

public int getProductGroupedResultsCount()

List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;

Returns
Type Description
int

getProductGroupedResultsList()

public List<ProductSearchResults.GroupedResult> getProductGroupedResultsList()

List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;

Returns
Type Description
List<GroupedResult>

getProductGroupedResultsOrBuilder(int index)

public ProductSearchResults.GroupedResultOrBuilder getProductGroupedResultsOrBuilder(int index)

List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;

Parameter
Name Description
index int
Returns
Type Description
ProductSearchResults.GroupedResultOrBuilder

getProductGroupedResultsOrBuilderList()

public List<? extends ProductSearchResults.GroupedResultOrBuilder> getProductGroupedResultsOrBuilderList()

List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;

Returns
Type Description
List<? extends com.google.cloud.vision.v1.ProductSearchResults.GroupedResultOrBuilder>

getResults(int index)

public ProductSearchResults.Result getResults(int index)

List of results, one for each product match.

repeated .google.cloud.vision.v1.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.v1.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.v1.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.v1.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.v1.ProductSearchResults.Result results = 5;

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasIndexTime()

public boolean hasIndexTime()

Timestamp of the index which provided these results. Products added to the product set and products removed from the product set 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