Class: Google::Apis::TranslateV3::TranslateService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/translate_v3/service.rb

Overview

Cloud Translation API

Integrates text translation into your website or application.

Examples:

require 'google/apis/translate_v3'

Translate = Google::Apis::TranslateV3 # Alias the module
service = Translate::TranslateService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeTranslateService


45
46
47
48
# File 'generated/google/apis/translate_v3/service.rb', line 45

def initialize
  super('https://translation.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/translate_v3/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/translate_v3/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_location_translate_text(parent, batch_translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


217
218
219
220
221
222
223
224
225
226
227
# File 'generated/google/apis/translate_v3/service.rb', line 217

def batch_location_translate_text(parent, batch_translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:batchTranslateText', options)
  command.request_representation = Google::Apis::TranslateV3::BatchTranslateTextRequest::Representation
  command.request_object = batch_translate_text_request_object
  command.response_representation = Google::Apis::TranslateV3::Operation::Representation
  command.response_class = Google::Apis::TranslateV3::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


607
608
609
610
611
612
613
614
615
616
617
# File 'generated/google/apis/translate_v3/service.rb', line 607

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:cancel', options)
  command.request_representation = Google::Apis::TranslateV3::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::TranslateV3::Empty::Representation
  command.response_class = Google::Apis::TranslateV3::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_glossary(parent, glossary_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


456
457
458
459
460
461
462
463
464
465
466
# File 'generated/google/apis/translate_v3/service.rb', line 456

def create_project_location_glossary(parent, glossary_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/glossaries', options)
  command.request_representation = Google::Apis::TranslateV3::Glossary::Representation
  command.request_object = glossary_object
  command.response_representation = Google::Apis::TranslateV3::Operation::Representation
  command.response_class = Google::Apis::TranslateV3::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_glossary(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation

Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


490
491
492
493
494
495
496
497
498
# File 'generated/google/apis/translate_v3/service.rb', line 490

def delete_project_location_glossary(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::Operation::Representation
  command.response_class = Google::Apis::TranslateV3::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


642
643
644
645
646
647
648
649
650
# File 'generated/google/apis/translate_v3/service.rb', line 642

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::Empty::Representation
  command.response_class = Google::Apis::TranslateV3::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#detect_location_language(parent, detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::DetectLanguageResponse

Detects the language of text within a request.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


257
258
259
260
261
262
263
264
265
266
267
# File 'generated/google/apis/translate_v3/service.rb', line 257

def detect_location_language(parent, detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:detectLanguage', options)
  command.request_representation = Google::Apis::TranslateV3::DetectLanguageRequest::Representation
  command.request_object = detect_language_request_object
  command.response_representation = Google::Apis::TranslateV3::DetectLanguageResponse::Representation
  command.response_class = Google::Apis::TranslateV3::DetectLanguageResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#detect_project_language(parent, detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::DetectLanguageResponse

Detects the language of text within a request.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


78
79
80
81
82
83
84
85
86
87
88
# File 'generated/google/apis/translate_v3/service.rb', line 78

def detect_project_language(parent, detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:detectLanguage', options)
  command.request_representation = Google::Apis::TranslateV3::DetectLanguageRequest::Representation
  command.request_object = detect_language_request_object
  command.response_representation = Google::Apis::TranslateV3::DetectLanguageResponse::Representation
  command.response_class = Google::Apis::TranslateV3::DetectLanguageResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Location

Gets information about a location.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


289
290
291
292
293
294
295
296
297
# File 'generated/google/apis/translate_v3/service.rb', line 289

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::Location::Representation
  command.response_class = Google::Apis::TranslateV3::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_glossary(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Glossary

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


521
522
523
524
525
526
527
528
529
# File 'generated/google/apis/translate_v3/service.rb', line 521

def get_project_location_glossary(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::Glossary::Representation
  command.response_class = Google::Apis::TranslateV3::Glossary
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


674
675
676
677
678
679
680
681
682
# File 'generated/google/apis/translate_v3/service.rb', line 674

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::Operation::Representation
  command.response_class = Google::Apis::TranslateV3::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_supported_languages(parent, display_language_code: nil, model: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::SupportedLanguages

Returns a list of supported languages for translation.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


341
342
343
344
345
346
347
348
349
350
351
# File 'generated/google/apis/translate_v3/service.rb', line 341

def get_project_location_supported_languages(parent, display_language_code: nil, model: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/supportedLanguages', options)
  command.response_representation = Google::Apis::TranslateV3::SupportedLanguages::Representation
  command.response_class = Google::Apis::TranslateV3::SupportedLanguages
  command.params['parent'] = parent unless parent.nil?
  command.query['displayLanguageCode'] = display_language_code unless display_language_code.nil?
  command.query['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_supported_languages(parent, display_language_code: nil, model: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::SupportedLanguages

Returns a list of supported languages for translation.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


132
133
134
135
136
137
138
139
140
141
142
# File 'generated/google/apis/translate_v3/service.rb', line 132

def get_project_supported_languages(parent, display_language_code: nil, model: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/supportedLanguages', options)
  command.response_representation = Google::Apis::TranslateV3::SupportedLanguages::Representation
  command.response_class = Google::Apis::TranslateV3::SupportedLanguages
  command.params['parent'] = parent unless parent.nil?
  command.query['displayLanguageCode'] = display_language_code unless display_language_code.nil?
  command.query['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_glossaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListGlossariesResponse

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


564
565
566
567
568
569
570
571
572
573
574
575
# File 'generated/google/apis/translate_v3/service.rb', line 564

def list_project_location_glossaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/glossaries', options)
  command.response_representation = Google::Apis::TranslateV3::ListGlossariesResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListGlossariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


718
719
720
721
722
723
724
725
726
727
728
729
# File 'generated/google/apis/translate_v3/service.rb', line 718

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}/operations', options)
  command.response_representation = Google::Apis::TranslateV3::ListOperationsResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListLocationsResponse

Lists information about the supported locations for this service.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


379
380
381
382
383
384
385
386
387
388
389
390
# File 'generated/google/apis/translate_v3/service.rb', line 379

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}/locations', options)
  command.response_representation = Google::Apis::TranslateV3::ListLocationsResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#translate_location_text(parent, translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::TranslateTextResponse

Translates input text and returns translated text.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


422
423
424
425
426
427
428
429
430
431
432
# File 'generated/google/apis/translate_v3/service.rb', line 422

def translate_location_text(parent, translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:translateText', options)
  command.request_representation = Google::Apis::TranslateV3::TranslateTextRequest::Representation
  command.request_object = translate_text_request_object
  command.response_representation = Google::Apis::TranslateV3::TranslateTextResponse::Representation
  command.response_class = Google::Apis::TranslateV3::TranslateTextResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#translate_project_text(parent, translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::TranslateTextResponse

Translates input text and returns translated text.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


174
175
176
177
178
179
180
181
182
183
184
# File 'generated/google/apis/translate_v3/service.rb', line 174

def translate_project_text(parent, translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:translateText', options)
  command.request_representation = Google::Apis::TranslateV3::TranslateTextRequest::Representation
  command.request_object = translate_text_request_object
  command.response_representation = Google::Apis::TranslateV3::TranslateTextResponse::Representation
  command.response_class = Google::Apis::TranslateV3::TranslateTextResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_operation(name, wait_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation

Waits for the specified long-running operation until it is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


760
761
762
763
764
765
766
767
768
769
770
# File 'generated/google/apis/translate_v3/service.rb', line 760

def wait_operation(name, wait_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:wait', options)
  command.request_representation = Google::Apis::TranslateV3::WaitOperationRequest::Representation
  command.request_object = wait_operation_request_object
  command.response_representation = Google::Apis::TranslateV3::Operation::Representation
  command.response_class = Google::Apis::TranslateV3::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end