com.google.api.services.vision.v1.model

Class AnnotateImageResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.vision.v1.model.AnnotateImageResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AnnotateImageResponse
extends com.google.api.client.json.GenericJson

Response to an image annotation request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Vision API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AnnotateImageResponse()

Method Summary

Modifier and Type	Method and Description
AnnotateImageResponse	clone()
ImageAnnotationContext	getContext() If present, contextual information is needed to understand where this image comes from.
CropHintsAnnotation	getCropHintsAnnotation() If present, crop hints have completed successfully.
Status	getError() If set, represents the error message for the operation.
List<FaceAnnotation>	getFaceAnnotations() If present, face detection has completed successfully.
TextAnnotation	getFullTextAnnotation() If present, text (OCR) detection or document (OCR) text detection has completed successfully.
ImageProperties	getImagePropertiesAnnotation() If present, image properties were extracted successfully.
List<EntityAnnotation>	getLabelAnnotations() If present, label detection has completed successfully.
List<EntityAnnotation>	getLandmarkAnnotations() If present, landmark detection has completed successfully.
List<LocalizedObjectAnnotation>	getLocalizedObjectAnnotations() If present, localized object detection has completed successfully.
List<EntityAnnotation>	getLogoAnnotations() If present, logo detection has completed successfully.
ProductSearchResults	getProductSearchResults() If present, product search has completed successfully.
SafeSearchAnnotation	getSafeSearchAnnotation() If present, safe-search annotation has completed successfully.
List<EntityAnnotation>	getTextAnnotations() If present, text (OCR) detection has completed successfully.
WebDetection	getWebDetection() If present, web detection has completed successfully.
AnnotateImageResponse	set(String fieldName, Object value)
AnnotateImageResponse	setContext(ImageAnnotationContext context) If present, contextual information is needed to understand where this image comes from.
AnnotateImageResponse	setCropHintsAnnotation(CropHintsAnnotation cropHintsAnnotation) If present, crop hints have completed successfully.
AnnotateImageResponse	setError(Status error) If set, represents the error message for the operation.
AnnotateImageResponse	setFaceAnnotations(List<FaceAnnotation> faceAnnotations) If present, face detection has completed successfully.
AnnotateImageResponse	setFullTextAnnotation(TextAnnotation fullTextAnnotation) If present, text (OCR) detection or document (OCR) text detection has completed successfully.
AnnotateImageResponse	setImagePropertiesAnnotation(ImageProperties imagePropertiesAnnotation) If present, image properties were extracted successfully.
AnnotateImageResponse	setLabelAnnotations(List<EntityAnnotation> labelAnnotations) If present, label detection has completed successfully.
AnnotateImageResponse	setLandmarkAnnotations(List<EntityAnnotation> landmarkAnnotations) If present, landmark detection has completed successfully.
AnnotateImageResponse	setLocalizedObjectAnnotations(List<LocalizedObjectAnnotation> localizedObjectAnnotations) If present, localized object detection has completed successfully.
AnnotateImageResponse	setLogoAnnotations(List<EntityAnnotation> logoAnnotations) If present, logo detection has completed successfully.
AnnotateImageResponse	setProductSearchResults(ProductSearchResults productSearchResults) If present, product search has completed successfully.
AnnotateImageResponse	setSafeSearchAnnotation(SafeSearchAnnotation safeSearchAnnotation) If present, safe-search annotation has completed successfully.
AnnotateImageResponse	setTextAnnotations(List<EntityAnnotation> textAnnotations) If present, text (OCR) detection has completed successfully.
AnnotateImageResponse	setWebDetection(WebDetection webDetection) If present, web detection has completed successfully.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AnnotateImageResponse

public AnnotateImageResponse()

Method Detail

getContext

public ImageAnnotationContext getContext()

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

Returns:

value or null for none

setContext

public AnnotateImageResponse setContext(ImageAnnotationContext context)

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

Parameters:

context - context or null for none

getCropHintsAnnotation

public CropHintsAnnotation getCropHintsAnnotation()

If present, crop hints have completed successfully.

Returns:

value or null for none

setCropHintsAnnotation

public AnnotateImageResponse setCropHintsAnnotation(CropHintsAnnotation cropHintsAnnotation)

If present, crop hints have completed successfully.

Parameters:

cropHintsAnnotation - cropHintsAnnotation or null for none

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.

Returns:

value or null for none

setError

public AnnotateImageResponse setError(Status error)

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.

Parameters:

error - error or null for none

getFaceAnnotations

public List<FaceAnnotation> getFaceAnnotations()

If present, face detection has completed successfully.

Returns:

value or null for none

setFaceAnnotations

public AnnotateImageResponse setFaceAnnotations(List<FaceAnnotation> faceAnnotations)

If present, face detection has completed successfully.

Parameters:

faceAnnotations - faceAnnotations or null for none

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.

Returns:

value or null for none

setFullTextAnnotation

public AnnotateImageResponse setFullTextAnnotation(TextAnnotation fullTextAnnotation)

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

Parameters:

fullTextAnnotation - fullTextAnnotation or null for none

getImagePropertiesAnnotation

public ImageProperties getImagePropertiesAnnotation()

If present, image properties were extracted successfully.

Returns:

value or null for none

setImagePropertiesAnnotation

public AnnotateImageResponse setImagePropertiesAnnotation(ImageProperties imagePropertiesAnnotation)

If present, image properties were extracted successfully.

Parameters:

imagePropertiesAnnotation - imagePropertiesAnnotation or null for none

getLabelAnnotations

public List<EntityAnnotation> getLabelAnnotations()

If present, label detection has completed successfully.

Returns:

value or null for none

setLabelAnnotations

public AnnotateImageResponse setLabelAnnotations(List<EntityAnnotation> labelAnnotations)

If present, label detection has completed successfully.

Parameters:

labelAnnotations - labelAnnotations or null for none

getLandmarkAnnotations

public List<EntityAnnotation> getLandmarkAnnotations()

If present, landmark detection has completed successfully.

Returns:

value or null for none

setLandmarkAnnotations

public AnnotateImageResponse setLandmarkAnnotations(List<EntityAnnotation> landmarkAnnotations)

If present, landmark detection has completed successfully.

Parameters:

landmarkAnnotations - landmarkAnnotations or null for none

getLocalizedObjectAnnotations

public List<LocalizedObjectAnnotation> getLocalizedObjectAnnotations()

If present, localized object detection has completed successfully. This will be sorted descending by confidence score.

Returns:

value or null for none

setLocalizedObjectAnnotations

public AnnotateImageResponse setLocalizedObjectAnnotations(List<LocalizedObjectAnnotation> localizedObjectAnnotations)

If present, localized object detection has completed successfully. This will be sorted descending by confidence score.

Parameters:

localizedObjectAnnotations - localizedObjectAnnotations or null for none

getLogoAnnotations

public List<EntityAnnotation> getLogoAnnotations()

If present, logo detection has completed successfully.

Returns:

value or null for none

setLogoAnnotations

public AnnotateImageResponse setLogoAnnotations(List<EntityAnnotation> logoAnnotations)

If present, logo detection has completed successfully.

Parameters:

logoAnnotations - logoAnnotations or null for none

getProductSearchResults

public ProductSearchResults getProductSearchResults()

If present, product search has completed successfully.

Returns:

value or null for none

setProductSearchResults

public AnnotateImageResponse setProductSearchResults(ProductSearchResults productSearchResults)

If present, product search has completed successfully.

Parameters:

productSearchResults - productSearchResults or null for none

getSafeSearchAnnotation

public SafeSearchAnnotation getSafeSearchAnnotation()

If present, safe-search annotation has completed successfully.

Returns:

value or null for none

setSafeSearchAnnotation

public AnnotateImageResponse setSafeSearchAnnotation(SafeSearchAnnotation safeSearchAnnotation)

If present, safe-search annotation has completed successfully.

Parameters:

safeSearchAnnotation - safeSearchAnnotation or null for none

getTextAnnotations

public List<EntityAnnotation> getTextAnnotations()

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

Returns:

value or null for none

setTextAnnotations

public AnnotateImageResponse setTextAnnotations(List<EntityAnnotation> textAnnotations)

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

Parameters:

textAnnotations - textAnnotations or null for none

getWebDetection

public WebDetection getWebDetection()

If present, web detection has completed successfully.

Returns:

value or null for none

setWebDetection

public AnnotateImageResponse setWebDetection(WebDetection webDetection)

If present, web detection has completed successfully.

Parameters:

webDetection - webDetection or null for none

set

public AnnotateImageResponse set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AnnotateImageResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson