Package com.google.cloud.vision.v1

Class Product

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.vision.v1.Product
All Implemented Interfaces:
ProductOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Product extends com.google.protobuf.GeneratedMessage implements ProductOrBuilder
 A Product contains ReferenceImages.
Protobuf type google.cloud.vision.v1.Product
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Product.Builder
    A Product contains ReferenceImages.
    static final class 
    Product.KeyValue
    A product label represented as a key-value pair.
    static interface 
    Product.KeyValueOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PRODUCT_CATEGORY_FIELD_NUMBER
     
    static final int
    PRODUCT_LABELS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Product
    getDefaultInstance()
     
    Product
    getDefaultInstanceForType()
     
    String
    getDescription()
    User-provided metadata to be stored with this product.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    User-provided metadata to be stored with this product.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    The user-provided name for this Product.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The user-provided name for this Product.
    String
    getName()
    The resource name of the product.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the product.
    com.google.protobuf.Parser<Product>
    getParserForType()
     
    String
    getProductCategory()
    Immutable.
    com.google.protobuf.ByteString
    getProductCategoryBytes()
    Immutable.
    Product.KeyValue
    getProductLabels(int index)
    Key-value pairs that can be attached to a product.
    int
    getProductLabelsCount()
    Key-value pairs that can be attached to a product.
    List<Product.KeyValue>
    getProductLabelsList()
    Key-value pairs that can be attached to a product.
    Product.KeyValueOrBuilder
    getProductLabelsOrBuilder(int index)
    Key-value pairs that can be attached to a product.
    List<? extends Product.KeyValueOrBuilder>
    getProductLabelsOrBuilderList()
    Key-value pairs that can be attached to a product.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Product.Builder
    newBuilder()
     
    static Product.Builder
    newBuilder(Product prototype)
     
    Product.Builder
    newBuilderForType()
     
    protected Product.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Product
    parseDelimitedFrom(InputStream input)
     
    static Product
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Product
    parseFrom(byte[] data)
     
    static Product
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Product
    parseFrom(com.google.protobuf.ByteString data)
     
    static Product
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Product
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Product
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Product
    parseFrom(InputStream input)
     
    static Product
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Product
    parseFrom(ByteBuffer data)
     
    static Product
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Product>
    parser()
     
    Product.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • PRODUCT_CATEGORY_FIELD_NUMBER

      public static final int PRODUCT_CATEGORY_FIELD_NUMBER
      See Also:

    • PRODUCT_LABELS_FIELD_NUMBER

      public static final int PRODUCT_LABELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      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;
      Specified by:
      getName in interface ProductOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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;
      Specified by:
      getNameBytes in interface ProductOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      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;
      Specified by:
      getDisplayName in interface ProductOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       The user-provided name for this Product. Must not be empty. Must be at most
 4096 characters long.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface ProductOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Specified by:
      getDescription in interface ProductOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface ProductOrBuilder
      Returns:
      The bytes for description.

    • getProductCategory

      public String getProductCategory()
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". 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];
      Specified by:
      getProductCategory in interface ProductOrBuilder
      Returns:
      The productCategory.

    • getProductCategoryBytes

      public com.google.protobuf.ByteString getProductCategoryBytes()
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". 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];
      Specified by:
      getProductCategoryBytes in interface ProductOrBuilder
      Returns:
      The bytes for productCategory.

    • getProductLabelsList

      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.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsList in interface ProductOrBuilder

    • getProductLabelsOrBuilderList

      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.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsOrBuilderList in interface ProductOrBuilder

    • getProductLabelsCount

      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.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsCount in interface ProductOrBuilder

    • getProductLabels

      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.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabels in interface ProductOrBuilder

    • getProductLabelsOrBuilder

      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.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsOrBuilder in interface ProductOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Product parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Product parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Product parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Product parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Product parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Product parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Product parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Product parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Product parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Product parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Product parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Product parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Product.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Product.Builder newBuilder()

    • newBuilder

      public static Product.Builder newBuilder(Product prototype)

    • toBuilder

      public Product.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Product.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Product getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Product> parser()

    • getParserForType

      public com.google.protobuf.Parser<Product> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Product getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder