public final class ProductSearchParams extends com.google.protobuf.GeneratedMessageV3 implements ProductSearchParamsOrBuilder
Parameters for a product search request.Protobuf type
google.cloud.vision.v1p3beta1.ProductSearchParams| Modifier and Type | Class and Description |
|---|---|
static class |
ProductSearchParams.Builder
Parameters for a product search request.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BOUNDING_POLY_FIELD_NUMBER |
static int |
CATALOG_NAME_FIELD_NUMBER |
static int |
CATEGORY_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
NORMALIZED_BOUNDING_POLY_FIELD_NUMBER |
static int |
PRODUCT_CATEGORIES_FIELD_NUMBER |
static int |
PRODUCT_CATEGORY_FIELD_NUMBER |
static int |
PRODUCT_SET_FIELD_NUMBER |
static int |
VIEW_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
BoundingPoly |
getBoundingPoly()
The bounding polygon around the area of interest in the image.
|
BoundingPolyOrBuilder |
getBoundingPolyOrBuilder()
The bounding polygon around the area of interest in the image.
|
String |
getCatalogName()
The resource name of the catalog to search.
|
com.google.protobuf.ByteString |
getCatalogNameBytes()
The resource name of the catalog to search.
|
ProductSearchCategory |
getCategory()
The category to search in.
|
int |
getCategoryValue()
The category to search in.
|
static ProductSearchParams |
getDefaultInstance() |
ProductSearchParams |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFilter()
The filtering expression.
|
com.google.protobuf.ByteString |
getFilterBytes()
The filtering expression.
|
NormalizedBoundingPoly |
getNormalizedBoundingPoly()
The bounding polygon around the area of interest in the image.
|
NormalizedBoundingPolyOrBuilder |
getNormalizedBoundingPolyOrBuilder()
The bounding polygon around the area of interest in the image.
|
com.google.protobuf.Parser<ProductSearchParams> |
getParserForType() |
String |
getProductCategories(int index)
The list of product categories to search in.
|
com.google.protobuf.ByteString |
getProductCategoriesBytes(int index)
The list of product categories to search in.
|
int |
getProductCategoriesCount()
The list of product categories to search in.
|
com.google.protobuf.ProtocolStringList |
getProductCategoriesList()
The list of product categories to search in.
|
String |
getProductCategory()
The product category to search in.
|
com.google.protobuf.ByteString |
getProductCategoryBytes()
The product category to search in.
|
String |
getProductSet()
The resource name of a
[ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for
similar images.
|
com.google.protobuf.ByteString |
getProductSetBytes()
The resource name of a
[ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for
similar images.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
ProductSearchResultsView |
getView()
Specifies the verbosity of the product search results.
|
int |
getViewValue()
Specifies the verbosity of the product search results.
|
boolean |
hasBoundingPoly()
The bounding polygon around the area of interest in the image.
|
int |
hashCode() |
boolean |
hasNormalizedBoundingPoly()
The bounding polygon around the area of interest in the image.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ProductSearchParams.Builder |
newBuilder() |
static ProductSearchParams.Builder |
newBuilder(ProductSearchParams prototype) |
ProductSearchParams.Builder |
newBuilderForType() |
protected ProductSearchParams.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ProductSearchParams |
parseDelimitedFrom(InputStream input) |
static ProductSearchParams |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProductSearchParams |
parseFrom(byte[] data) |
static ProductSearchParams |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProductSearchParams |
parseFrom(ByteBuffer data) |
static ProductSearchParams |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProductSearchParams |
parseFrom(com.google.protobuf.ByteString data) |
static ProductSearchParams |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProductSearchParams |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ProductSearchParams |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ProductSearchParams |
parseFrom(InputStream input) |
static ProductSearchParams |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ProductSearchParams> |
parser() |
ProductSearchParams.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int CATALOG_NAME_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER
public static final int PRODUCT_CATEGORY_FIELD_NUMBER
public static final int NORMALIZED_BOUNDING_POLY_FIELD_NUMBER
public static final int BOUNDING_POLY_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER
public static final int PRODUCT_SET_FIELD_NUMBER
public static final int PRODUCT_CATEGORIES_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getCatalogName()
The resource name of the catalog to search. Format is: `productSearch/catalogs/CATALOG_NAME`.
string catalog_name = 1;getCatalogName in interface ProductSearchParamsOrBuilderpublic com.google.protobuf.ByteString getCatalogNameBytes()
The resource name of the catalog to search. Format is: `productSearch/catalogs/CATALOG_NAME`.
string catalog_name = 1;getCatalogNameBytes in interface ProductSearchParamsOrBuilderpublic int getCategoryValue()
The category to search in. Optional. It is inferred by the system if it is not specified. [Deprecated] Use `product_category`.
.google.cloud.vision.v1p3beta1.ProductSearchCategory category = 2;getCategoryValue in interface ProductSearchParamsOrBuilderpublic ProductSearchCategory getCategory()
The category to search in. Optional. It is inferred by the system if it is not specified. [Deprecated] Use `product_category`.
.google.cloud.vision.v1p3beta1.ProductSearchCategory category = 2;getCategory in interface ProductSearchParamsOrBuilderpublic String getProductCategory()
The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are `bag`, `shoe`, `sunglasses`, `dress`, `outerwear`, `skirt`, `top`, `shorts`, and `pants`.
string product_category = 5;getProductCategory in interface ProductSearchParamsOrBuilderpublic com.google.protobuf.ByteString getProductCategoryBytes()
The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are `bag`, `shoe`, `sunglasses`, `dress`, `outerwear`, `skirt`, `top`, `shorts`, and `pants`.
string product_category = 5;getProductCategoryBytes in interface ProductSearchParamsOrBuilderpublic boolean hasNormalizedBoundingPoly()
The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use `bounding_poly`.
.google.cloud.vision.v1p3beta1.NormalizedBoundingPoly normalized_bounding_poly = 3;
hasNormalizedBoundingPoly in interface ProductSearchParamsOrBuilderpublic NormalizedBoundingPoly getNormalizedBoundingPoly()
The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use `bounding_poly`.
.google.cloud.vision.v1p3beta1.NormalizedBoundingPoly normalized_bounding_poly = 3;
getNormalizedBoundingPoly in interface ProductSearchParamsOrBuilderpublic NormalizedBoundingPolyOrBuilder getNormalizedBoundingPolyOrBuilder()
The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use `bounding_poly`.
.google.cloud.vision.v1p3beta1.NormalizedBoundingPoly normalized_bounding_poly = 3;
getNormalizedBoundingPolyOrBuilder in interface ProductSearchParamsOrBuilderpublic boolean hasBoundingPoly()
The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 9;hasBoundingPoly in interface ProductSearchParamsOrBuilderpublic BoundingPoly getBoundingPoly()
The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 9;getBoundingPoly in interface ProductSearchParamsOrBuilderpublic BoundingPolyOrBuilder getBoundingPolyOrBuilder()
The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 9;getBoundingPolyOrBuilder in interface ProductSearchParamsOrBuilderpublic int getViewValue()
Specifies the verbosity of the product search results. Optional. Defaults to `BASIC`.
.google.cloud.vision.v1p3beta1.ProductSearchResultsView view = 4;getViewValue in interface ProductSearchParamsOrBuilderpublic ProductSearchResultsView getView()
Specifies the verbosity of the product search results. Optional. Defaults to `BASIC`.
.google.cloud.vision.v1p3beta1.ProductSearchResultsView view = 4;getView in interface ProductSearchParamsOrBuilderpublic String getProductSet()
The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
string product_set = 6 [(.google.api.resource_reference) = { ... }getProductSet in interface ProductSearchParamsOrBuilderpublic com.google.protobuf.ByteString getProductSetBytes()
The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
string product_set = 6 [(.google.api.resource_reference) = { ... }getProductSetBytes in interface ProductSearchParamsOrBuilderpublic com.google.protobuf.ProtocolStringList getProductCategoriesList()
The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.
repeated string product_categories = 7;getProductCategoriesList in interface ProductSearchParamsOrBuilderpublic int getProductCategoriesCount()
The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.
repeated string product_categories = 7;getProductCategoriesCount in interface ProductSearchParamsOrBuilderpublic String getProductCategories(int index)
The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.
repeated string product_categories = 7;getProductCategories in interface ProductSearchParamsOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getProductCategoriesBytes(int index)
The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.
repeated string product_categories = 7;getProductCategoriesBytes in interface ProductSearchParamsOrBuilderindex - The index of the value to return.public String getFilter()
The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".
string filter = 8;getFilter in interface ProductSearchParamsOrBuilderpublic com.google.protobuf.ByteString getFilterBytes()
The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".
string filter = 8;getFilterBytes in interface ProductSearchParamsOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ProductSearchParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProductSearchParams parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProductSearchParams parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProductSearchParams parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProductSearchParams parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProductSearchParams parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProductSearchParams parseFrom(InputStream input) throws IOException
IOExceptionpublic static ProductSearchParams parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ProductSearchParams parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ProductSearchParams parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ProductSearchParams parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ProductSearchParams parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ProductSearchParams.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ProductSearchParams.Builder newBuilder()
public static ProductSearchParams.Builder newBuilder(ProductSearchParams prototype)
public ProductSearchParams.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ProductSearchParams.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ProductSearchParams getDefaultInstance()
public static com.google.protobuf.Parser<ProductSearchParams> parser()
public com.google.protobuf.Parser<ProductSearchParams> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ProductSearchParams getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2020 Google LLC. All rights reserved.