Vision.Projects.Files.AsyncBatchAnnotate (Cloud Vision API v1 (Rev. 451) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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.v1.VisionRequest<Operation>
        
        com.google.api.services.vision.v1.Vision.Projects.Files.AsyncBatchAnnotate

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Vision.Projects.Files
```
public class Vision.Projects.Files.AsyncBatchAnnotate
extends VisionRequest<Operation>
```

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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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`	`AsyncBatchAnnotate(java.lang.String parent, AsyncBatchAnnotateFilesRequest content)` Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page.

Method Summary

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

Methods inherited from class com.google.api.services.vision.v1.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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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
  - AsyncBatchAnnotate
```
protected AsyncBatchAnnotate(java.lang.String parent,
                             AsyncBatchAnnotateFilesRequest content)
```
    Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). Create a request for the method "files.asyncBatchAnnotate". 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.
    AsyncBatchAnnotate#initialize(com.google.api.client.googleapis.services.A bstractGoogleClientRequest) 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 AsyncBatchAnnotateFilesRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Vision.Projects.Files.AsyncBatchAnnotate set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: VisionRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class VisionRequest<Operation>
  - setAccessToken
```
public Vision.Projects.Files.AsyncBatchAnnotate setAccessToken(java.lang.String accessToken)
```
    Description copied from class: VisionRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class VisionRequest<Operation>
  - setAlt
```
public Vision.Projects.Files.AsyncBatchAnnotate setAlt(java.lang.String alt)
```
    Description copied from class: VisionRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class VisionRequest<Operation>
  - setCallback
```
public Vision.Projects.Files.AsyncBatchAnnotate setCallback(java.lang.String callback)
```
    Description copied from class: VisionRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class VisionRequest<Operation>
  - setFields
```
public Vision.Projects.Files.AsyncBatchAnnotate setFields(java.lang.String fields)
```
    Description copied from class: VisionRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class VisionRequest<Operation>
  - setKey
```
public Vision.Projects.Files.AsyncBatchAnnotate setKey(java.lang.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<Operation>
  - setOauthToken
```
public Vision.Projects.Files.AsyncBatchAnnotate setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: VisionRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class VisionRequest<Operation>
  - setPrettyPrint
```
public Vision.Projects.Files.AsyncBatchAnnotate setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: VisionRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class VisionRequest<Operation>
  - setQuotaUser
```
public Vision.Projects.Files.AsyncBatchAnnotate setQuotaUser(java.lang.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<Operation>
  - setUploadType
```
public Vision.Projects.Files.AsyncBatchAnnotate setUploadType(java.lang.String uploadType)
```
    Description copied from class: VisionRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class VisionRequest<Operation>
  - setUploadProtocol
```
public Vision.Projects.Files.AsyncBatchAnnotate setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: VisionRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class VisionRequest<Operation>
  - getParent
```
public java.lang.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.AsyncBatchAnnotate setParent(java.lang.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.AsyncBatchAnnotate set(java.lang.String parameterName,
                                                    java.lang.Object value)
```
    Overrides:
    
    set in class VisionRequest<Operation>

Cloud Vision API v1 (revision 451)

Class Vision.Projects.Files.AsyncBatchAnnotate

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AsyncBatchAnnotate

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

set