Class AnnotateImageResponse (3.47.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
Type Description
int

CROP_HINTS_ANNOTATION_FIELD_NUMBER

public static final int CROP_HINTS_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

FACE_ANNOTATIONS_FIELD_NUMBER

public static final int FACE_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

FULL_TEXT_ANNOTATION_FIELD_NUMBER

public static final int FULL_TEXT_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_PROPERTIES_ANNOTATION_FIELD_NUMBER

public static final int IMAGE_PROPERTIES_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

LABEL_ANNOTATIONS_FIELD_NUMBER

public static final int LABEL_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

LANDMARK_ANNOTATIONS_FIELD_NUMBER

public static final int LANDMARK_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

LOGO_ANNOTATIONS_FIELD_NUMBER

public static final int LOGO_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

SAFE_SEARCH_ANNOTATION_FIELD_NUMBER

public static final int SAFE_SEARCH_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

TEXT_ANNOTATIONS_FIELD_NUMBER

public static final int TEXT_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

WEB_DETECTION_FIELD_NUMBER

public static final int WEB_DETECTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnnotateImageResponse getDefaultInstance()
Returns
Type Description
AnnotateImageResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnnotateImageResponse.Builder newBuilder()
Returns
Type Description
AnnotateImageResponse.Builder

newBuilder(AnnotateImageResponse prototype)

public static AnnotateImageResponse.Builder newBuilder(AnnotateImageResponse prototype)
Parameter
Name Description
prototype AnnotateImageResponse
Returns
Type Description
AnnotateImageResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateImageResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnnotateImageResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateImageResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateImageResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnnotateImageResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnnotateImageResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateImageResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateImageResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotateImageResponse> parser()
Returns
Type Description
Parser<AnnotateImageResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
ImageAnnotationContextOrBuilder

getCropHintsAnnotation()

public CropHintsAnnotation getCropHintsAnnotation()

If present, crop hints have completed successfully.

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

Returns
Type Description
CropHintsAnnotation

The cropHintsAnnotation.

getCropHintsAnnotationOrBuilder()

public CropHintsAnnotationOrBuilder getCropHintsAnnotationOrBuilder()

If present, crop hints have completed successfully.

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

Returns
Type Description
CropHintsAnnotationOrBuilder

getDefaultInstanceForType()

public AnnotateImageResponse getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
FaceAnnotation

getFaceAnnotationsCount()

public int getFaceAnnotationsCount()

If present, face detection has completed successfully.

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

Returns
Type Description
int

getFaceAnnotationsList()

public List<FaceAnnotation> getFaceAnnotationsList()

If present, face detection has completed successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
FaceAnnotationOrBuilder

getFaceAnnotationsOrBuilderList()

public List<? extends FaceAnnotationOrBuilder> getFaceAnnotationsOrBuilderList()

If present, face detection has completed successfully.

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

Returns
Type Description
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
Type Description
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
Type Description
TextAnnotationOrBuilder

getImagePropertiesAnnotation()

public ImageProperties getImagePropertiesAnnotation()

If present, image properties were extracted successfully.

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

Returns
Type Description
ImageProperties

The imagePropertiesAnnotation.

getImagePropertiesAnnotationOrBuilder()

public ImagePropertiesOrBuilder getImagePropertiesAnnotationOrBuilder()

If present, image properties were extracted successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotation

getLabelAnnotationsCount()

public int getLabelAnnotationsCount()

If present, label detection has completed successfully.

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

Returns
Type Description
int

getLabelAnnotationsList()

public List<EntityAnnotation> getLabelAnnotationsList()

If present, label detection has completed successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotationOrBuilder

getLabelAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getLabelAnnotationsOrBuilderList()

If present, label detection has completed successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotation

getLandmarkAnnotationsCount()

public int getLandmarkAnnotationsCount()

If present, landmark detection has completed successfully.

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

Returns
Type Description
int

getLandmarkAnnotationsList()

public List<EntityAnnotation> getLandmarkAnnotationsList()

If present, landmark detection has completed successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotationOrBuilder

getLandmarkAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getLandmarkAnnotationsOrBuilderList()

If present, landmark detection has completed successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotation

getLogoAnnotationsCount()

public int getLogoAnnotationsCount()

If present, logo detection has completed successfully.

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

Returns
Type Description
int

getLogoAnnotationsList()

public List<EntityAnnotation> getLogoAnnotationsList()

If present, logo detection has completed successfully.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotationOrBuilder

getLogoAnnotationsOrBuilderList()

public List<? extends EntityAnnotationOrBuilder> getLogoAnnotationsOrBuilderList()

If present, logo detection has completed successfully.

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

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

getParserForType()

public Parser<AnnotateImageResponse> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
SafeSearchAnnotationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
EntityAnnotation

getTextAnnotationsCount()

public int getTextAnnotationsCount()

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

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

Returns
Type Description
int

getTextAnnotationsList()

public List<EntityAnnotation> getTextAnnotationsList()

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

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
WebDetection

The webDetection.

getWebDetectionOrBuilder()

public WebDetectionOrBuilder getWebDetectionOrBuilder()

If present, web detection has completed successfully.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the webDetection field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnnotateImageResponse.Builder newBuilderForType()
Returns
Type Description
AnnotateImageResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateImageResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnnotateImageResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnnotateImageResponse.Builder toBuilder()
Returns
Type Description
AnnotateImageResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException