module Google::Cloud::Translate
Constants
- VERSION
Public Class Methods
Configure the google-cloud-translate library.
The following configuration parameters are supported:
-
`credentials` (type: `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
-
`lib_name` (type: `String`) - The library name as recorded in instrumentation and logging.
-
`lib_version` (type: `String`) - The library version as recorded in instrumentation and logging.
-
`interceptors` (type: `Array<GRPC::ClientInterceptor>`) - An array of interceptors that are run before calls are executed.
-
`timeout` (type: `Numeric`) - Default timeout in seconds.
-
`metadata` (type: `Hash{Symbol=>String}`) - Additional gRPC headers to be sent with the call.
-
`retry_policy` (type: `Hash`) - The retry policy. The value is a hash with the following keys:
* `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. * `:retry_codes` (*type:* `Array<String>`) - The error codes that should trigger a retry.
@return [::Google::Cloud::Config] The default configuration used by this library
# File lib/google/cloud/translate.rb, line 105 def self.configure yield ::Google::Cloud.configure.translate if block_given? ::Google::Cloud.configure.translate end
Create a new client object for TranslationService.
By default, this returns an instance of [Google::Cloud::Translate::V3::TranslationService::Client](googleapis.dev/ruby/google-cloud-translate-v3/latest/Google/Cloud/Translate/V3/TranslationService/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the TranslationService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About TranslationService
Provides natural language translation operations.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [TranslationService::Client] A client object for the specified version.
# File lib/google/cloud/translate.rb, line 66 def self.translation_service version: :v3, &block require "google/cloud/translate/#{version.to_s.downcase}" package_name = Google::Cloud::Translate .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Translate.const_get package_name package_module.const_get(:TranslationService).const_get(:Client).new(&block) end
Creates a new object for connecting to the legacy V2 version of the Cloud
Translation API.
Like other Cloud
Platform services, Google
Cloud
Translation API supports authentication using a project ID and OAuth 2.0 credentials. In addition, it supports authentication using a public API access key. (If both the API key and the project and OAuth 2.0 credentials are provided, the API key will be used.) Instructions and configuration options are covered in the {file:AUTHENTICATION.md Authentication Guide}.
@param [String] project_id Project identifier for the Cloud
Translation service you are connecting to. If not
present, the default project for the credentials is used.
@param [String, Hash, Google::Auth::Credentials] credentials The path to the keyfile as a String, the contents
of the keyfile as a Hash, or a Google::Auth::Credentials object.
@param [String] key a public API access key (not an OAuth 2.0 token) @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the set of resources and operations that
the connection can access. See [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/OAuth2). The default scope is: * `https://www.googleapis.com/auth/cloud-platform`
@param [Integer] retries Number of times to retry requests on server error. The default value is `3`.
Optional.
@param [Integer] timeout Default timeout to use in requests. Optional. @param [String] endpoint Override of the endpoint host name. Optional. If the param is nil, uses the default
endpoint.
@return [Google::Cloud::Translate::V2::Api]
@example
require "google/cloud/translate/v2" translate = Google::Cloud::Translate::V2.new( version: :v2, project_id: "my-todo-project", credentials: "/path/to/keyfile.json" ) translation = translate.translate "Hello world!", to: "la" translation.text #=> "Salve mundi!"
@example Using API Key.
require "google/cloud/translate/v2" translate = Google::Cloud::Translate::V2.new( key: "api-key-abc123XYZ789" ) translation = translate.translate "Hello world!", to: "la" translation.text #=> "Salve mundi!"
@example Using API Key from the environment variable.
require "google/cloud/translate/v2" ENV["TRANSLATE_KEY"] = "api-key-abc123XYZ789" translate = Google::Cloud::Translate::V2.new translation = translate.translate "Hello world!", to: "la" translation.text #=> "Salve mundi!"
# File lib/google/cloud/translate/helpers.rb, line 82 def self.translation_v2_service project_id: nil, credentials: nil, key: nil, scope: nil, retries: nil, timeout: nil, endpoint: nil require "google/cloud/translate/v2" Google::Cloud::Translate::V2.new project_id: project_id, credentials: credentials, key: key, scope: scope, retries: retries, timeout: timeout, endpoint: endpoint end