Class AnnotateImageResponse (3.30.0)

public final class AnnotateImageResponse extends GeneratedMessageV3 implements AnnotateImageResponseOrBuilder

Response to an image annotation request.

Protobuf type google.cloud.vision.v1p2beta1.AnnotateImageResponse

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

CROP_HINTS_ANNOTATION_FIELD_NUMBER

public static final int CROP_HINTS_ANNOTATION_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

FACE_ANNOTATIONS_FIELD_NUMBER

public static final int FACE_ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

FULL_TEXT_ANNOTATION_FIELD_NUMBER

public static final int FULL_TEXT_ANNOTATION_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_PROPERTIES_ANNOTATION_FIELD_NUMBER

public static final int IMAGE_PROPERTIES_ANNOTATION_FIELD_NUMBER
Field Value
TypeDescription
int

LABEL_ANNOTATIONS_FIELD_NUMBER

public static final int LABEL_ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

LANDMARK_ANNOTATIONS_FIELD_NUMBER

public static final int LANDMARK_ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

LOGO_ANNOTATIONS_FIELD_NUMBER

public static final int LOGO_ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

SAFE_SEARCH_ANNOTATION_FIELD_NUMBER

public static final int SAFE_SEARCH_ANNOTATION_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_ANNOTATIONS_FIELD_NUMBER

public static final int TEXT_ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

WEB_DETECTION_FIELD_NUMBER

public static final int WEB_DETECTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotateImageResponse getDefaultInstance()
Returns
TypeDescription
AnnotateImageResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AnnotateImageResponse.Builder newBuilder()
Returns
TypeDescription
AnnotateImageResponse.Builder

newBuilder(AnnotateImageResponse prototype)

public static AnnotateImageResponse.Builder newBuilder(AnnotateImageResponse prototype)
Parameter
NameDescription
prototypeAnnotateImageResponse
Returns
TypeDescription
AnnotateImageResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateImageResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AnnotateImageResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateImageResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateImageResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AnnotateImageResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AnnotateImageResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateImageResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AnnotateImageResponse> parser()
Returns
TypeDescription
Parser<AnnotateImageResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContext()

public ImageAnnotationContext getContext()

If present, contextual information is needed to understand where this image comes from.

.google.cloud.vision.v1p2beta1.ImageAnnotationContext context = 21;

Returns
TypeDescription
ImageAnnotationContext

The context.

getContextOrBuilder()

public ImageAnnotationContextOrBuilder getContextOrBuilder()

If present, contextual information is needed to understand where this image comes from.

.google.cloud.vision.v1p2beta1.ImageAnnotationContext context = 21;

Returns
TypeDescription
ImageAnnotationContextOrBuilder

getCropHintsAnnotation()

public CropHintsAnnotation getCropHintsAnnotation()

If present, crop hints have completed successfully.

.google.cloud.vision.v1p2beta1.CropHintsAnnotation crop_hints_annotation = 11;

Returns
TypeDescription
CropHintsAnnotation

The cropHintsAnnotation.

getCropHintsAnnotationOrBuilder()

public CropHintsAnnotationOrBuilder getCropHintsAnnotationOrBuilder()

If present, crop hints have completed successfully.

.google.cloud.vision.v1p2beta1.CropHintsAnnotation crop_hints_annotation = 11;

Returns
TypeDescription
CropHintsAnnotationOrBuilder

getDefaultInstanceForType()

public AnnotateImageResponse getDefaultInstanceForType()
Returns
TypeDescription
AnnotateImageResponse

getError()

public Status getError()

If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when error is set.

.google.rpc.Status error = 9;

Returns
TypeDescription
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when error is set.

.google.rpc.Status error = 9;

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getFaceAnnotations(int index)

public FaceAnnotation getFaceAnnotations(int index)

If present, face detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.FaceAnnotation face_annotations = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
FaceAnnotation

getFaceAnnotationsCount()

public int getFaceAnnotationsCount()

If present, face detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.FaceAnnotation face_annotations = 1;

Returns
TypeDescription
int

getFaceAnnotationsList()

public List<FaceAnnotation> getFaceAnnotationsList()

If present, face detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.FaceAnnotation face_annotations = 1;

Returns
TypeDescription
List<FaceAnnotation>

getFaceAnnotationsOrBuilder(int index)

public FaceAnnotationOrBuilder getFaceAnnotationsOrBuilder(int index)

If present, face detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.FaceAnnotation face_annotations = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
FaceAnnotationOrBuilder

getFaceAnnotationsOrBuilderList()

public List<? extends FaceAnnotationOrBuilder> getFaceAnnotationsOrBuilderList()

If present, face detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.FaceAnnotation face_annotations = 1;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p2beta1.FaceAnnotationOrBuilder>

getFullTextAnnotation()

public TextAnnotation getFullTextAnnotation()

If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

.google.cloud.vision.v1p2beta1.TextAnnotation full_text_annotation = 12;

Returns
TypeDescription
TextAnnotation

The fullTextAnnotation.

getFullTextAnnotationOrBuilder()

public TextAnnotationOrBuilder getFullTextAnnotationOrBuilder()

If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

.google.cloud.vision.v1p2beta1.TextAnnotation full_text_annotation = 12;

Returns
TypeDescription
TextAnnotationOrBuilder

getImagePropertiesAnnotation()

public ImageProperties getImagePropertiesAnnotation()

If present, image properties were extracted successfully.

.google.cloud.vision.v1p2beta1.ImageProperties image_properties_annotation = 8;

Returns
TypeDescription
ImageProperties

The imagePropertiesAnnotation.

getImagePropertiesAnnotationOrBuilder()

public ImagePropertiesOrBuilder getImagePropertiesAnnotationOrBuilder()

If present, image properties were extracted successfully.

.google.cloud.vision.v1p2beta1.ImageProperties image_properties_annotation = 8;

Returns
TypeDescription
ImagePropertiesOrBuilder

getLabelAnnotations(int index)

public EntityAnnotation getLabelAnnotations(int index)

If present, label detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation label_annotations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotation

getLabelAnnotationsCount()

public int getLabelAnnotationsCount()

If present, label detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation label_annotations = 4;

Returns
TypeDescription
int

getLabelAnnotationsList()

public List<EntityAnnotation> getLabelAnnotationsList()

If present, label detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation label_annotations = 4;

Returns
TypeDescription
List<EntityAnnotation>

getLabelAnnotationsOrBuilder(int index)

public EntityAnnotationOrBuilder getLabelAnnotationsOrBuilder(int index)

If present, label detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation label_annotations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotationOrBuilder

getLabelAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getLabelAnnotationsOrBuilderList()

If present, label detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation label_annotations = 4;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p2beta1.EntityAnnotationOrBuilder>

getLandmarkAnnotations(int index)

public EntityAnnotation getLandmarkAnnotations(int index)

If present, landmark detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation landmark_annotations = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotation

getLandmarkAnnotationsCount()

public int getLandmarkAnnotationsCount()

If present, landmark detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation landmark_annotations = 2;

Returns
TypeDescription
int

getLandmarkAnnotationsList()

public List<EntityAnnotation> getLandmarkAnnotationsList()

If present, landmark detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation landmark_annotations = 2;

Returns
TypeDescription
List<EntityAnnotation>

getLandmarkAnnotationsOrBuilder(int index)

public EntityAnnotationOrBuilder getLandmarkAnnotationsOrBuilder(int index)

If present, landmark detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation landmark_annotations = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotationOrBuilder

getLandmarkAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getLandmarkAnnotationsOrBuilderList()

If present, landmark detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation landmark_annotations = 2;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p2beta1.EntityAnnotationOrBuilder>

getLogoAnnotations(int index)

public EntityAnnotation getLogoAnnotations(int index)

If present, logo detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation logo_annotations = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotation

getLogoAnnotationsCount()

public int getLogoAnnotationsCount()

If present, logo detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation logo_annotations = 3;

Returns
TypeDescription
int

getLogoAnnotationsList()

public List<EntityAnnotation> getLogoAnnotationsList()

If present, logo detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation logo_annotations = 3;

Returns
TypeDescription
List<EntityAnnotation>

getLogoAnnotationsOrBuilder(int index)

public EntityAnnotationOrBuilder getLogoAnnotationsOrBuilder(int index)

If present, logo detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation logo_annotations = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotationOrBuilder

getLogoAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getLogoAnnotationsOrBuilderList()

If present, logo detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation logo_annotations = 3;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p2beta1.EntityAnnotationOrBuilder>

getParserForType()

public Parser<AnnotateImageResponse> getParserForType()
Returns
TypeDescription
Parser<AnnotateImageResponse>
Overrides

getSafeSearchAnnotation()

public SafeSearchAnnotation getSafeSearchAnnotation()

If present, safe-search annotation has completed successfully.

.google.cloud.vision.v1p2beta1.SafeSearchAnnotation safe_search_annotation = 6;

Returns
TypeDescription
SafeSearchAnnotation

The safeSearchAnnotation.

getSafeSearchAnnotationOrBuilder()

public SafeSearchAnnotationOrBuilder getSafeSearchAnnotationOrBuilder()

If present, safe-search annotation has completed successfully.

.google.cloud.vision.v1p2beta1.SafeSearchAnnotation safe_search_annotation = 6;

Returns
TypeDescription
SafeSearchAnnotationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTextAnnotations(int index)

public EntityAnnotation getTextAnnotations(int index)

If present, text (OCR) detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation text_annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotation

getTextAnnotationsCount()

public int getTextAnnotationsCount()

If present, text (OCR) detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation text_annotations = 5;

Returns
TypeDescription
int

getTextAnnotationsList()

public List<EntityAnnotation> getTextAnnotationsList()

If present, text (OCR) detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation text_annotations = 5;

Returns
TypeDescription
List<EntityAnnotation>

getTextAnnotationsOrBuilder(int index)

public EntityAnnotationOrBuilder getTextAnnotationsOrBuilder(int index)

If present, text (OCR) detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation text_annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityAnnotationOrBuilder

getTextAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getTextAnnotationsOrBuilderList()

If present, text (OCR) detection has completed successfully.

repeated .google.cloud.vision.v1p2beta1.EntityAnnotation text_annotations = 5;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p2beta1.EntityAnnotationOrBuilder>

getWebDetection()

public WebDetection getWebDetection()

If present, web detection has completed successfully.

.google.cloud.vision.v1p2beta1.WebDetection web_detection = 13;

Returns
TypeDescription
WebDetection

The webDetection.

getWebDetectionOrBuilder()

public WebDetectionOrBuilder getWebDetectionOrBuilder()

If present, web detection has completed successfully.

.google.cloud.vision.v1p2beta1.WebDetection web_detection = 13;

Returns
TypeDescription
WebDetectionOrBuilder

hasContext()

public boolean hasContext()

If present, contextual information is needed to understand where this image comes from.

.google.cloud.vision.v1p2beta1.ImageAnnotationContext context = 21;

Returns
TypeDescription
boolean

Whether the context field is set.

hasCropHintsAnnotation()

public boolean hasCropHintsAnnotation()

If present, crop hints have completed successfully.

.google.cloud.vision.v1p2beta1.CropHintsAnnotation crop_hints_annotation = 11;

Returns
TypeDescription
boolean

Whether the cropHintsAnnotation field is set.

hasError()

public boolean hasError()

If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when error is set.

.google.rpc.Status error = 9;

Returns
TypeDescription
boolean

Whether the error field is set.

hasFullTextAnnotation()

public boolean hasFullTextAnnotation()

If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

.google.cloud.vision.v1p2beta1.TextAnnotation full_text_annotation = 12;

Returns
TypeDescription
boolean

Whether the fullTextAnnotation field is set.

hasImagePropertiesAnnotation()

public boolean hasImagePropertiesAnnotation()

If present, image properties were extracted successfully.

.google.cloud.vision.v1p2beta1.ImageProperties image_properties_annotation = 8;

Returns
TypeDescription
boolean

Whether the imagePropertiesAnnotation field is set.

hasSafeSearchAnnotation()

public boolean hasSafeSearchAnnotation()

If present, safe-search annotation has completed successfully.

.google.cloud.vision.v1p2beta1.SafeSearchAnnotation safe_search_annotation = 6;

Returns
TypeDescription
boolean

Whether the safeSearchAnnotation field is set.

hasWebDetection()

public boolean hasWebDetection()

If present, web detection has completed successfully.

.google.cloud.vision.v1p2beta1.WebDetection web_detection = 13;

Returns
TypeDescription
boolean

Whether the webDetection field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AnnotateImageResponse.Builder newBuilderForType()
Returns
TypeDescription
AnnotateImageResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateImageResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AnnotateImageResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AnnotateImageResponse.Builder toBuilder()
Returns
TypeDescription
AnnotateImageResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException