Package com.google.cloud.vision.v1p4beta1

Class ReferenceImage

  • All Implemented Interfaces:
    ReferenceImageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReferenceImage
extends com.google.protobuf.GeneratedMessageV3
implements ReferenceImageOrBuilder
     A `ReferenceImage` represents a product image and its associated metadata,
 such as bounding boxes.
    Protobuf type google.cloud.vision.v1p4beta1.ReferenceImage
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ReferenceImage.Builder
      A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BOUNDING_POLYS_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  
      static int URI_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         The resource name of the reference image.

 Format is:

 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.

 This field is ignored when creating a reference image.
        string name = 1;
        Specified by:
        getName in interface ReferenceImageOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the reference image.

 Format is:

 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.

 This field is ignored when creating a reference image.
        string name = 1;
        Specified by:
        getNameBytes in interface ReferenceImageOrBuilder
        Returns:
        The bytes for name.

      • getUri

        public String getUri()
         Required. The Google Cloud Storage URI of the reference image.

 The URI must start with `gs://`.
        string uri = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUri in interface ReferenceImageOrBuilder
        Returns:
        The uri.

      • getUriBytes

        public com.google.protobuf.ByteString getUriBytes()
         Required. The Google Cloud Storage URI of the reference image.

 The URI must start with `gs://`.
        string uri = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUriBytes in interface ReferenceImageOrBuilder
        Returns:
        The bytes for uri.

      • getBoundingPolysList

        public List<BoundingPoly> getBoundingPolysList()
         Optional. Bounding polygons around the areas of interest in the reference
 image. If this field is empty, the system will try to detect regions of
 interest. At most 10 bounding polygons will be used.

 The provided shape is converted into a non-rotated rectangle. Once
 converted, the small edge of the rectangle must be greater than or equal
 to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
 is not).
        repeated .google.cloud.vision.v1p4beta1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBoundingPolysList in interface ReferenceImageOrBuilder

      • getBoundingPolysOrBuilderList

        public List<? extends BoundingPolyOrBuilder> getBoundingPolysOrBuilderList()
         Optional. Bounding polygons around the areas of interest in the reference
 image. If this field is empty, the system will try to detect regions of
 interest. At most 10 bounding polygons will be used.

 The provided shape is converted into a non-rotated rectangle. Once
 converted, the small edge of the rectangle must be greater than or equal
 to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
 is not).
        repeated .google.cloud.vision.v1p4beta1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBoundingPolysOrBuilderList in interface ReferenceImageOrBuilder

      • getBoundingPolysCount

        public int getBoundingPolysCount()
         Optional. Bounding polygons around the areas of interest in the reference
 image. If this field is empty, the system will try to detect regions of
 interest. At most 10 bounding polygons will be used.

 The provided shape is converted into a non-rotated rectangle. Once
 converted, the small edge of the rectangle must be greater than or equal
 to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
 is not).
        repeated .google.cloud.vision.v1p4beta1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBoundingPolysCount in interface ReferenceImageOrBuilder

      • getBoundingPolys

        public BoundingPoly getBoundingPolys​(int index)
         Optional. Bounding polygons around the areas of interest in the reference
 image. If this field is empty, the system will try to detect regions of
 interest. At most 10 bounding polygons will be used.

 The provided shape is converted into a non-rotated rectangle. Once
 converted, the small edge of the rectangle must be greater than or equal
 to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
 is not).
        repeated .google.cloud.vision.v1p4beta1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBoundingPolys in interface ReferenceImageOrBuilder

      • getBoundingPolysOrBuilder

        public BoundingPolyOrBuilder getBoundingPolysOrBuilder​(int index)
         Optional. Bounding polygons around the areas of interest in the reference
 image. If this field is empty, the system will try to detect regions of
 interest. At most 10 bounding polygons will be used.

 The provided shape is converted into a non-rotated rectangle. Once
 converted, the small edge of the rectangle must be greater than or equal
 to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
 is not).
        repeated .google.cloud.vision.v1p4beta1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBoundingPolysOrBuilder in interface ReferenceImageOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 ReferenceImage parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ReferenceImage.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ReferenceImage getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ReferenceImage> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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