Method: googleapis.translate.v3beta1.projects.locations.batchTranslateText

Translates a large volume of text 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.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters

Parameters
`parent`	`string` Required. Location to make a call. Must refer to a caller's project. 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.
`body`	`object (BatchTranslateTextRequest)` Required.

parent

string

Required. Location to make a call. Must refer to a caller's project. 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.

body

object (BatchTranslateTextRequest)

Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
`OperationError`	If the long-running operation finished unsuccessfully.
`ResponseTypeError`	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- batchTranslateText:
    call: googleapis.translate.v3beta1.projects.locations.batchTranslateText
    args:
        parent: ...
        body:
            glossaries: ...
            inputConfigs: ...
            labels: ...
            models: ...
            outputConfig:
                gcsDestination:
                    outputUriPrefix: ...
            sourceLanguageCode: ...
            targetLanguageCodes: ...
    result: batchTranslateTextResult

JSON

[
  {
    "batchTranslateText": {
      "call": "googleapis.translate.v3beta1.projects.locations.batchTranslateText",
      "args": {
        "parent": "...",
        "body": {
          "glossaries": "...",
          "inputConfigs": "...",
          "labels": "...",
          "models": "...",
          "outputConfig": {
            "gcsDestination": {
              "outputUriPrefix": "..."
            }
          },
          "sourceLanguageCode": "...",
          "targetLanguageCodes": "..."
        }
      },
      "result": "batchTranslateTextResult"
    }
  }
]