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

Class GoogleCloudVisionV1p2beta1AnnotateFileResponse

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.GoogleCloudVisionV1p2beta1AnnotateFileResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudVisionV1p2beta1AnnotateFileResponse
extends 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

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

Method Summary

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

GoogleCloudVisionV1p2beta1AnnotateFileResponse

public GoogleCloudVisionV1p2beta1AnnotateFileResponse()

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 GoogleCloudVisionV1p2beta1AnnotateFileResponse 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 GoogleCloudVisionV1p2beta1InputConfig getInputConfig()

Information about the file for which this response is generated.

Returns:

value or null for none

setInputConfig

public GoogleCloudVisionV1p2beta1AnnotateFileResponse setInputConfig(GoogleCloudVisionV1p2beta1InputConfig inputConfig)

Information about the file for which this response is generated.

Parameters:

inputConfig - inputConfig or null for none

getResponses

public List<GoogleCloudVisionV1p2beta1AnnotateImageResponse> 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 GoogleCloudVisionV1p2beta1AnnotateFileResponse setResponses(List<GoogleCloudVisionV1p2beta1AnnotateImageResponse> 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 GoogleCloudVisionV1p2beta1AnnotateFileResponse setTotalPages(Integer totalPages)

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

Parameters:

totalPages - totalPages or null for none

set

public GoogleCloudVisionV1p2beta1AnnotateFileResponse set(String fieldName,
                                                          Object value)

Overrides:

set in class GenericJson

clone

public GoogleCloudVisionV1p2beta1AnnotateFileResponse clone()

Overrides:

clone in class GenericJson