com.google.api.services.translate.v3

Class Translate.Projects.Locations.BatchTranslateDocument

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.translate.v3.TranslateRequest<Operation>

com.google.api.services.translate.v3.Translate.Projects.Locations.BatchTranslateDocument

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Translate.Projects.Locations

public class Translate.Projects.Locations.BatchTranslateDocument
extends TranslateRequest<Operation>

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	BatchTranslateDocument(String parent, BatchTranslateDocumentRequest content) Translates a large volume of document in asynchronous batch mode.

Method Summary

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

Methods inherited from class com.google.api.services.translate.v3.TranslateRequest

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

BatchTranslateDocument

protected BatchTranslateDocument(String parent,
                                 BatchTranslateDocumentRequest content)

Translates a large volume of document in asynchronous batch mode. This function provides real- time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call. Create a request for the method "locations.batchTranslateDocument". This request holds the parameters needed by the the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

parent - Required. Location to make a regional call. Format: `projects/{project-number-or-id}/locations /{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

content - the BatchTranslateDocumentRequest

Since:

1.13

Method Detail

set$Xgafv

public Translate.Projects.Locations.BatchTranslateDocument set$Xgafv(String $Xgafv)

Description copied from class: TranslateRequest

V1 error format.

Overrides:

set$Xgafv in class TranslateRequest<Operation>

setAccessToken

public Translate.Projects.Locations.BatchTranslateDocument setAccessToken(String accessToken)

Description copied from class: TranslateRequest

OAuth access token.

Overrides:

setAccessToken in class TranslateRequest<Operation>

setAlt

public Translate.Projects.Locations.BatchTranslateDocument setAlt(String alt)

Description copied from class: TranslateRequest

Data format for response.

Overrides:

setAlt in class TranslateRequest<Operation>

setCallback

public Translate.Projects.Locations.BatchTranslateDocument setCallback(String callback)

Description copied from class: TranslateRequest

JSONP

Overrides:

setCallback in class TranslateRequest<Operation>

setFields

public Translate.Projects.Locations.BatchTranslateDocument setFields(String fields)

Description copied from class: TranslateRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class TranslateRequest<Operation>

setKey

public Translate.Projects.Locations.BatchTranslateDocument setKey(String key)

Description copied from class: TranslateRequest

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 TranslateRequest<Operation>

setOauthToken

public Translate.Projects.Locations.BatchTranslateDocument setOauthToken(String oauthToken)

Description copied from class: TranslateRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class TranslateRequest<Operation>

setPrettyPrint

public Translate.Projects.Locations.BatchTranslateDocument setPrettyPrint(Boolean prettyPrint)

Description copied from class: TranslateRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class TranslateRequest<Operation>

setQuotaUser

public Translate.Projects.Locations.BatchTranslateDocument setQuotaUser(String quotaUser)

Description copied from class: TranslateRequest

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 TranslateRequest<Operation>

setUploadType

public Translate.Projects.Locations.BatchTranslateDocument setUploadType(String uploadType)

Description copied from class: TranslateRequest

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

Overrides:

setUploadType in class TranslateRequest<Operation>

setUploadProtocol

public Translate.Projects.Locations.BatchTranslateDocument setUploadProtocol(String uploadProtocol)

Description copied from class: TranslateRequest

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

Overrides:

setUploadProtocol in class TranslateRequest<Operation>

getParent

public String getParent()

Required. Location to make a regional call. Format: `projects/{project-number-or-id}/locations /{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

setParent

public Translate.Projects.Locations.BatchTranslateDocument setParent(String parent)

Required. Location to make a regional call. Format: `projects/{project-number-or- id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

set

public Translate.Projects.Locations.BatchTranslateDocument set(String parameterName,
                                                               Object value)

Overrides:

set in class TranslateRequest<Operation>