com.google.api.services.vision.v1p1beta1

Class Vision.Projects.Files.Annotate

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.vision.v1p1beta1.VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

com.google.api.services.vision.v1p1beta1.Vision.Projects.Files.Annotate

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Vision.Projects.Files

public class Vision.Projects.Files.Annotate
extends VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Annotate(String parent, GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest content) Service that performs image detection and annotation for a batch of files.

Method Summary

Modifier and Type	Method and Description
String	getParent() Optional.
Vision.Projects.Files.Annotate	set(String parameterName, Object value)
Vision.Projects.Files.Annotate	set$Xgafv(String $Xgafv) V1 error format.
Vision.Projects.Files.Annotate	setAccessToken(String accessToken) OAuth access token.
Vision.Projects.Files.Annotate	setAlt(String alt) Data format for response.
Vision.Projects.Files.Annotate	setCallback(String callback) JSONP
Vision.Projects.Files.Annotate	setFields(String fields) Selector specifying which fields to include in a partial response.
Vision.Projects.Files.Annotate	setKey(String key) API key.
Vision.Projects.Files.Annotate	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Vision.Projects.Files.Annotate	setParent(String parent) Optional.
Vision.Projects.Files.Annotate	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Vision.Projects.Files.Annotate	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Vision.Projects.Files.Annotate	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Vision.Projects.Files.Annotate	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.vision.v1p1beta1.VisionRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

Annotate

protected Annotate(String parent,
                   GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest content)

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. Create a request for the method "files.annotate". This request holds the parameters needed by the the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Vision.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

parent - Optional. Target project and location to make a call. Format: `projects/{project-id}/locations /{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.

content - the GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest

Since:

1.13

Method Detail

set$Xgafv

public Vision.Projects.Files.Annotate set$Xgafv(String $Xgafv)

Description copied from class: VisionRequest

V1 error format.

Overrides:

set$Xgafv in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setAccessToken

public Vision.Projects.Files.Annotate setAccessToken(String accessToken)

Description copied from class: VisionRequest

OAuth access token.

Overrides:

setAccessToken in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setAlt

public Vision.Projects.Files.Annotate setAlt(String alt)

Description copied from class: VisionRequest

Data format for response.

Overrides:

setAlt in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setCallback

public Vision.Projects.Files.Annotate setCallback(String callback)

Description copied from class: VisionRequest

JSONP

Overrides:

setCallback in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setFields

public Vision.Projects.Files.Annotate setFields(String fields)

Description copied from class: VisionRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setKey

public Vision.Projects.Files.Annotate setKey(String key)

Description copied from class: VisionRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setOauthToken

public Vision.Projects.Files.Annotate setOauthToken(String oauthToken)

Description copied from class: VisionRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setPrettyPrint

public Vision.Projects.Files.Annotate setPrettyPrint(Boolean prettyPrint)

Description copied from class: VisionRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setQuotaUser

public Vision.Projects.Files.Annotate setQuotaUser(String quotaUser)

Description copied from class: VisionRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setUploadType

public Vision.Projects.Files.Annotate setUploadType(String uploadType)

Description copied from class: VisionRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

setUploadProtocol

public Vision.Projects.Files.Annotate setUploadProtocol(String uploadProtocol)

Description copied from class: VisionRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>

getParent

public String getParent()

Optional. Target project and location to make a call. Format: `projects/{project-id}/locations /{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.

setParent

public Vision.Projects.Files.Annotate setParent(String parent)

Optional. Target project and location to make a call. Format: `projects/{project- id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.

set

public Vision.Projects.Files.Annotate set(String parameterName,
                                          Object value)

Overrides:

set in class VisionRequest<GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse>