public final class Product extends GeneratedMessageV3 implements ProductOrBuilder
A Product contains ReferenceImages.Protobuf type
google.cloud.vision.v1p4beta1.Product
Modifier and Type | Class and Description |
---|---|
static class |
Product.Builder
A Product contains ReferenceImages.
|
static class |
Product.KeyValue
A product label represented as a key-value pair.
|
static interface |
Product.KeyValueOrBuilder |
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PRODUCT_CATEGORY_FIELD_NUMBER |
static int |
PRODUCT_LABELS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, 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, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int PRODUCT_CATEGORY_FIELD_NUMBER
public static final int PRODUCT_LABELS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public String getName()
The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.
string name = 1;
getName
in interface ProductOrBuilder
public ByteString getNameBytes()
The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.
string name = 1;
getNameBytes
in interface ProductOrBuilder
public String getDisplayName()
The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
getDisplayName
in interface ProductOrBuilder
public ByteString getDisplayNameBytes()
The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
getDisplayNameBytes
in interface ProductOrBuilder
public String getDescription()
User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
getDescription
in interface ProductOrBuilder
public ByteString getDescriptionBytes()
User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
getDescriptionBytes
in interface ProductOrBuilder
public String getProductCategory()
Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.
string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
getProductCategory
in interface ProductOrBuilder
public ByteString getProductCategoryBytes()
Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.
string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
getProductCategoryBytes
in interface ProductOrBuilder
public List<Product.KeyValue> getProductLabelsList()
Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1p4beta1.Product.KeyValue product_labels = 5;
getProductLabelsList
in interface ProductOrBuilder
public List<? extends Product.KeyValueOrBuilder> getProductLabelsOrBuilderList()
Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1p4beta1.Product.KeyValue product_labels = 5;
getProductLabelsOrBuilderList
in interface ProductOrBuilder
public int getProductLabelsCount()
Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1p4beta1.Product.KeyValue product_labels = 5;
getProductLabelsCount
in interface ProductOrBuilder
public Product.KeyValue getProductLabels(int index)
Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1p4beta1.Product.KeyValue product_labels = 5;
getProductLabels
in interface ProductOrBuilder
public Product.KeyValueOrBuilder getProductLabelsOrBuilder(int index)
Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1p4beta1.Product.KeyValue product_labels = 5;
getProductLabelsOrBuilder
in interface ProductOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static Product parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Product parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Product parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Product parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Product parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Product parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Product parseFrom(InputStream input) throws IOException
IOException
public static Product parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Product parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Product parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Product parseFrom(CodedInputStream input) throws IOException
IOException
public static Product parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public Product.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static Product.Builder newBuilder()
public static Product.Builder newBuilder(Product prototype)
public Product.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected Product.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static Product getDefaultInstance()
public Parser<Product> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public Product getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.