Class: Google::Apis::TranslateV3::TranslateService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::TranslateV3::TranslateService
- Defined in:
- lib/google/apis/translate_v3/service.rb
Overview
Cloud Translation API
Integrates text translation into your website or application.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#batch_location_translate_document(parent, batch_translate_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Translates a large volume of document in asynchronous batch mode.
-
#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.
-
#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.
-
#create_project_location_dataset(parent, dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Creates a Dataset.
-
#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.
-
#create_project_location_glossary_glossary_entry(parent, glossary_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::GlossaryEntry
Creates a glossary entry.
-
#create_project_location_model(parent, model_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Creates a Model.
-
#delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Deletes a dataset and all of its contents.
-
#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.
-
#delete_project_location_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty
Deletes a single entry from the glossary.
-
#delete_project_location_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Deletes a model.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty
Deletes a long-running operation.
-
#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.
-
#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.
-
#export_dataset_data(dataset, export_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Exports dataset's data to the provided output location.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Location
Gets information about a location.
-
#get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Dataset
Gets a Dataset.
-
#get_project_location_glossary(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Glossary
Gets a glossary.
-
#get_project_location_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::GlossaryEntry
Gets a single glossary entry by the given id.
-
#get_project_location_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Model
Gets a model.
-
#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.
-
#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.
-
#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.
-
#import_dataset_data(dataset, import_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Import sentence pairs into translation Dataset.
-
#initialize ⇒ TranslateService
constructor
A new instance of TranslateService.
-
#list_project_location_dataset_examples(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListExamplesResponse
Lists sentence pairs in the dataset.
-
#list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListDatasetsResponse
Lists datasets.
-
#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.
-
#list_project_location_glossary_glossary_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListGlossaryEntriesResponse
List the entries for the glossary.
-
#list_project_location_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListModelsResponse
Lists models.
-
#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.
-
#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.
-
#patch_project_location_glossary(name, glossary_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Updates a glossary.
-
#patch_project_location_glossary_glossary_entry(name, glossary_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::GlossaryEntry
Updates a glossary entry.
-
#translate_location_document(parent, translate_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::TranslateDocumentResponse
Translates documents in synchronous mode.
-
#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.
-
#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.
-
#wait_operation(name, wait_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.
Constructor Details
#initialize ⇒ TranslateService
Returns a new instance of TranslateService.
45 46 47 48 49 50 |
# File 'lib/google/apis/translate_v3/service.rb', line 45 def initialize super('https://translation.googleapis.com/', '', client_name: 'google-apis-translate_v3', client_version: Google::Apis::TranslateV3::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns 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.
38 39 40 |
# File 'lib/google/apis/translate_v3/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns 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.
43 44 45 |
# File 'lib/google/apis/translate_v3/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#batch_location_translate_document(parent, batch_translate_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
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.
208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/google/apis/translate_v3/service.rb', line 208 def batch_location_translate_document(parent, batch_translate_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}:batchTranslateDocument', ) command.request_representation = Google::Apis::TranslateV3::BatchTranslateDocumentRequest::Representation command.request_object = batch_translate_document_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 |
#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.
250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/google/apis/translate_v3/service.rb', line 250 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', ) 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
.
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 |
# File 'lib/google/apis/translate_v3/service.rb', line 1268 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', ) 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_dataset(parent, dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Creates a Dataset.
520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/google/apis/translate_v3/service.rb', line 520 def create_project_location_dataset(parent, dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/datasets', ) command.request_representation = Google::Apis::TranslateV3::Dataset::Representation command.request_object = dataset_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 |
#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.
766 767 768 769 770 771 772 773 774 775 776 |
# File 'lib/google/apis/translate_v3/service.rb', line 766 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', ) 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 |
#create_project_location_glossary_glossary_entry(parent, glossary_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::GlossaryEntry
Creates a glossary entry.
956 957 958 959 960 961 962 963 964 965 966 |
# File 'lib/google/apis/translate_v3/service.rb', line 956 def create_project_location_glossary_glossary_entry(parent, glossary_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/glossaryEntries', ) command.request_representation = Google::Apis::TranslateV3::GlossaryEntry::Representation command.request_object = glossary_entry_object command.response_representation = Google::Apis::TranslateV3::GlossaryEntry::Representation command.response_class = Google::Apis::TranslateV3::GlossaryEntry 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 |
#create_project_location_model(parent, model_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Creates a Model.
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 |
# File 'lib/google/apis/translate_v3/service.rb', line 1124 def create_project_location_model(parent, model_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/models', ) command.request_representation = Google::Apis::TranslateV3::Model::Representation command.request_object = model_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_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Deletes a dataset and all of its contents.
552 553 554 555 556 557 558 559 560 |
# File 'lib/google/apis/translate_v3/service.rb', line 552 def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) 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_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.
799 800 801 802 803 804 805 806 807 |
# File 'lib/google/apis/translate_v3/service.rb', line 799 def delete_project_location_glossary(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) 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_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty
Deletes a single entry from the glossary
988 989 990 991 992 993 994 995 996 |
# File 'lib/google/apis/translate_v3/service.rb', line 988 def delete_project_location_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) 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 |
#delete_project_location_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Deletes a model.
1156 1157 1158 1159 1160 1161 1162 1163 1164 |
# File 'lib/google/apis/translate_v3/service.rb', line 1156 def delete_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) 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
.
1303 1304 1305 1306 1307 1308 1309 1310 1311 |
# File 'lib/google/apis/translate_v3/service.rb', line 1303 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) 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.
288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/google/apis/translate_v3/service.rb', line 288 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', ) 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.
78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/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', ) 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 |
#export_dataset_data(dataset, export_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Exports dataset's data to the provided output location.
584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/google/apis/translate_v3/service.rb', line 584 def export_dataset_data(dataset, export_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+dataset}:exportData', ) command.request_representation = Google::Apis::TranslateV3::ExportDataRequest::Representation command.request_object = export_data_request_object command.response_representation = Google::Apis::TranslateV3::Operation::Representation command.response_class = Google::Apis::TranslateV3::Operation command.params['dataset'] = dataset unless dataset.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.
320 321 322 323 324 325 326 327 328 |
# File 'lib/google/apis/translate_v3/service.rb', line 320 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) 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_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Dataset
Gets a Dataset.
616 617 618 619 620 621 622 623 624 |
# File 'lib/google/apis/translate_v3/service.rb', line 616 def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) command.response_representation = Google::Apis::TranslateV3::Dataset::Representation command.response_class = Google::Apis::TranslateV3::Dataset 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.
829 830 831 832 833 834 835 836 837 |
# File 'lib/google/apis/translate_v3/service.rb', line 829 def get_project_location_glossary(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) 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_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::GlossaryEntry
Gets a single glossary entry by the given id.
1018 1019 1020 1021 1022 1023 1024 1025 1026 |
# File 'lib/google/apis/translate_v3/service.rb', line 1018 def get_project_location_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) command.response_representation = Google::Apis::TranslateV3::GlossaryEntry::Representation command.response_class = Google::Apis::TranslateV3::GlossaryEntry 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_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Model
Gets a model.
1186 1187 1188 1189 1190 1191 1192 1193 1194 |
# File 'lib/google/apis/translate_v3/service.rb', line 1186 def get_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) command.response_representation = Google::Apis::TranslateV3::Model::Representation command.response_class = Google::Apis::TranslateV3::Model 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.
1334 1335 1336 1337 1338 1339 1340 1341 1342 |
# File 'lib/google/apis/translate_v3/service.rb', line 1334 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) 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.
367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/google/apis/translate_v3/service.rb', line 367 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', ) 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.
127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/google/apis/translate_v3/service.rb', line 127 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', ) 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 |
#import_dataset_data(dataset, import_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Import sentence pairs into translation Dataset.
648 649 650 651 652 653 654 655 656 657 658 |
# File 'lib/google/apis/translate_v3/service.rb', line 648 def import_dataset_data(dataset, import_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+dataset}:importData', ) command.request_representation = Google::Apis::TranslateV3::ImportDataRequest::Representation command.request_object = import_data_request_object command.response_representation = Google::Apis::TranslateV3::Operation::Representation command.response_class = Google::Apis::TranslateV3::Operation command.params['dataset'] = dataset unless dataset.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_dataset_examples(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListExamplesResponse
Lists sentence pairs in the dataset.
731 732 733 734 735 736 737 738 739 740 741 742 |
# File 'lib/google/apis/translate_v3/service.rb', line 731 def list_project_location_dataset_examples(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+parent}/examples', ) command.response_representation = Google::Apis::TranslateV3::ListExamplesResponse::Representation command.response_class = Google::Apis::TranslateV3::ListExamplesResponse 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_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListDatasetsResponse
Lists datasets.
688 689 690 691 692 693 694 695 696 697 698 |
# File 'lib/google/apis/translate_v3/service.rb', line 688 def list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+parent}/datasets', ) command.response_representation = Google::Apis::TranslateV3::ListDatasetsResponse::Representation command.response_class = Google::Apis::TranslateV3::ListDatasetsResponse command.params['parent'] = parent unless parent.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_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.
882 883 884 885 886 887 888 889 890 891 892 893 |
# File 'lib/google/apis/translate_v3/service.rb', line 882 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', ) 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_glossary_glossary_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListGlossaryEntriesResponse
List the entries for the glossary.
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 |
# File 'lib/google/apis/translate_v3/service.rb', line 1056 def list_project_location_glossary_glossary_entries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+parent}/glossaryEntries', ) command.response_representation = Google::Apis::TranslateV3::ListGlossaryEntriesResponse::Representation command.response_class = Google::Apis::TranslateV3::ListGlossaryEntriesResponse command.params['parent'] = parent unless parent.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_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListModelsResponse
Lists models.
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 |
# File 'lib/google/apis/translate_v3/service.rb', line 1227 def list_project_location_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+parent}/models', ) command.response_representation = Google::Apis::TranslateV3::ListModelsResponse::Representation command.response_class = Google::Apis::TranslateV3::ListModelsResponse 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
.
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 |
# File 'lib/google/apis/translate_v3/service.rb', line 1371 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', ) 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.
409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/google/apis/translate_v3/service.rb', line 409 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', ) 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 |
#patch_project_location_glossary(name, glossary_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation
Updates a glossary. A LRO is used since the update can be async if the glossary's entry file is updated.
922 923 924 925 926 927 928 929 930 931 932 933 |
# File 'lib/google/apis/translate_v3/service.rb', line 922 def patch_project_location_glossary(name, glossary_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v3/{+name}', ) 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['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_glossary_glossary_entry(name, glossary_entry_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::GlossaryEntry
Updates a glossary entry.
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/apis/translate_v3/service.rb', line 1090 def patch_project_location_glossary_glossary_entry(name, glossary_entry_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v3/{+name}', ) command.request_representation = Google::Apis::TranslateV3::GlossaryEntry::Representation command.request_object = glossary_entry_object command.response_representation = Google::Apis::TranslateV3::GlossaryEntry::Representation command.response_class = Google::Apis::TranslateV3::GlossaryEntry 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 |
#translate_location_document(parent, translate_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::TranslateDocumentResponse
Translates documents in synchronous mode.
448 449 450 451 452 453 454 455 456 457 458 |
# File 'lib/google/apis/translate_v3/service.rb', line 448 def translate_location_document(parent, translate_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}:translateDocument', ) command.request_representation = Google::Apis::TranslateV3::TranslateDocumentRequest::Representation command.request_object = translate_document_request_object command.response_representation = Google::Apis::TranslateV3::TranslateDocumentResponse::Representation command.response_class = Google::Apis::TranslateV3::TranslateDocumentResponse 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_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.
487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/google/apis/translate_v3/service.rb', line 487 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', ) 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.
166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/google/apis/translate_v3/service.rb', line 166 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', ) 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 until the specified long-running operation 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.
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 |
# File 'lib/google/apis/translate_v3/service.rb', line 1412 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', ) 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 |