com.google.cloud.vision.v1

Interface ReferenceImageOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ReferenceImage, ReferenceImage.Builder

public interface ReferenceImageOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
BoundingPoly	getBoundingPolys(int index) Optional.
int	getBoundingPolysCount() Optional.
List<BoundingPoly>	getBoundingPolysList() Optional.
BoundingPolyOrBuilder	getBoundingPolysOrBuilder(int index) Optional.
List<? extends BoundingPolyOrBuilder>	getBoundingPolysOrBuilderList() Optional.
String	getName() The resource name of the reference image.
ByteString	getNameBytes() The resource name of the reference image.
String	getUri() Required.
ByteString	getUriBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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;

Returns:

The name.

getNameBytes

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;

Returns:

The bytes for name.

getUri

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];

Returns:

The uri.

getUriBytes

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];

Returns:

The bytes for uri.

getBoundingPolysList

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.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];

getBoundingPolys

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.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];

getBoundingPolysCount

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.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];

getBoundingPolysOrBuilderList

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.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];

getBoundingPolysOrBuilder

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.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];