Cloud Translation V3 Client - Class TranslationServiceClient (1.16.0)

Reference documentation and code samples for the Cloud Translation V3 Client class TranslationServiceClient.

Service Description: Provides natural language translation operations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Translate\V3\TranslationServiceClient for the stable implementation

Namespace

Google \ Cloud \ Translate \ V3 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchTranslateDocument

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.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::batchTranslateDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\BatchTranslateDocumentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

batchTranslateText

Translates a large volume of text in asynchronous batch mode.

This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::batchTranslateTextAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\BatchTranslateTextRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createGlossary

Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::createGlossaryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\CreateGlossaryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteGlossary

Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.

Returns NOT_FOUND, if the glossary doesn't exist.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::deleteGlossaryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\DeleteGlossaryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

detectLanguage

Detects the language of text within a request.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::detectLanguageAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\DetectLanguageRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Translate\V3\DetectLanguageResponse`

getGlossary

Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::getGlossaryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\GetGlossaryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Translate\V3\Glossary`

getSupportedLanguages

Returns a list of supported languages for translation.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::getSupportedLanguagesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\GetSupportedLanguagesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Translate\V3\SupportedLanguages`

listGlossaries

Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::listGlossariesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\ListGlossariesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

translateDocument

Translates documents in synchronous mode.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::translateDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\TranslateDocumentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Translate\V3\TranslateDocumentResponse`

translateText

Translates input text and returns translated text.

The async variant is Google\Cloud\Translate\V3\Client\TranslationServiceClient::translateTextAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\TranslateTextRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Translate\V3\TranslateTextResponse`

batchTranslateDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\BatchTranslateDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

batchTranslateTextAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\BatchTranslateTextRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createGlossaryAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\CreateGlossaryRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteGlossaryAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\DeleteGlossaryRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

detectLanguageAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\DetectLanguageRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getGlossaryAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\GetGlossaryRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSupportedLanguagesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\GetSupportedLanguagesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listGlossariesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\ListGlossariesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

translateDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\TranslateDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

translateTextAsync

Parameters
Name	Description
`request`	`Google\Cloud\Translate\V3\TranslateTextRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::glossaryName

Formats a string containing the fully-qualified path to represent a glossary resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`glossary`	`string`

Returns
Type	Description
`string`	The formatted glossary resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

glossary: projects/{project}/locations/{location}/glossaries/{glossary}
location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.