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

Class AnnotateFileRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AnnotateFileRequest
extends GenericJson

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

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

Method Summary

Modifier and Type	Method and Description
AnnotateFileRequest	clone()
List<Feature>	getFeatures() Required.
ImageContext	getImageContext() Additional context that may accompany the image(s) in the file.
InputConfig	getInputConfig() Required.
List<Integer>	getPages() Pages of the file to perform image annotation.
AnnotateFileRequest	set(String fieldName, Object value)
AnnotateFileRequest	setFeatures(List<Feature> features) Required.
AnnotateFileRequest	setImageContext(ImageContext imageContext) Additional context that may accompany the image(s) in the file.
AnnotateFileRequest	setInputConfig(InputConfig inputConfig) Required.
AnnotateFileRequest	setPages(List<Integer> pages) Pages of the file to perform image annotation.

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

AnnotateFileRequest

public AnnotateFileRequest()

Method Detail

getFeatures

public List<Feature> getFeatures()

Required. Requested features.

Returns:

value or null for none

setFeatures

public AnnotateFileRequest setFeatures(List<Feature> features)

Required. Requested features.

Parameters:

features - features or null for none

getImageContext

public ImageContext getImageContext()

Additional context that may accompany the image(s) in the file.

Returns:

value or null for none

setImageContext

public AnnotateFileRequest setImageContext(ImageContext imageContext)

Additional context that may accompany the image(s) in the file.

Parameters:

imageContext - imageContext or null for none

getInputConfig

public InputConfig getInputConfig()

Required. Information about the input file.

Returns:

value or null for none

setInputConfig

public AnnotateFileRequest setInputConfig(InputConfig inputConfig)

Required. Information about the input file.

Parameters:

inputConfig - inputConfig or null for none

getPages

public List<Integer> getPages()

Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.

Returns:

value or null for none

setPages

public AnnotateFileRequest setPages(List<Integer> pages)

Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.

Parameters:

pages - pages or null for none

set

public AnnotateFileRequest set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public AnnotateFileRequest clone()

Overrides:

clone in class GenericJson