com.google.api.services.vision.v1p2beta1.model

Class AnnotateFileResponse

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.v1p2beta1.model.AnnotateFileResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

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
AnnotateFileResponse()

Method Summary

Modifier and Type	Method and Description
AnnotateFileResponse	clone()
Status	getError() If set, represents the error message for the failed request.
InputConfig	getInputConfig() Information about the file for which this response is generated.
List<AnnotateImageResponse>	getResponses() Individual responses to images found within the file.
Integer	getTotalPages() This field gives the total number of pages in the file.
AnnotateFileResponse	set(String fieldName, Object value)
AnnotateFileResponse	setError(Status error) If set, represents the error message for the failed request.
AnnotateFileResponse	setInputConfig(InputConfig inputConfig) Information about the file for which this response is generated.
AnnotateFileResponse	setResponses(List<AnnotateImageResponse> responses) Individual responses to images found within the file.
AnnotateFileResponse	setTotalPages(Integer totalPages) This field gives the total number of pages in the file.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

AnnotateFileResponse

public AnnotateFileResponse()

Method Detail

getError

public Status getError()

If set, represents the error message for the failed request. The `responses` field will not be set in this case.

Returns:

value or null for none

setError

public AnnotateFileResponse setError(Status error)

If set, represents the error message for the failed request. The `responses` field will not be set in this case.

Parameters:

error - error or null for none

getInputConfig

public InputConfig getInputConfig()

Information about the file for which this response is generated.

Returns:

value or null for none

setInputConfig

public AnnotateFileResponse setInputConfig(InputConfig inputConfig)

Information about the file for which this response is generated.

Parameters:

inputConfig - inputConfig or null for none

getResponses

public List<AnnotateImageResponse> getResponses()

Individual responses to images found within the file. This field will be empty if the `error` field is set.

Returns:

value or null for none

setResponses

public AnnotateFileResponse setResponses(List<AnnotateImageResponse> responses)

Individual responses to images found within the file. This field will be empty if the `error` field is set.

Parameters:

responses - responses or null for none

getTotalPages

public Integer getTotalPages()

This field gives the total number of pages in the file.

Returns:

value or null for none

setTotalPages

public AnnotateFileResponse setTotalPages(Integer totalPages)

This field gives the total number of pages in the file.

Parameters:

totalPages - totalPages or null for none

set

public AnnotateFileResponse set(String fieldName,
                                Object value)

Overrides:

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

clone

public AnnotateFileResponse clone()

Overrides:

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