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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/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:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://translation.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TranslateService

Returns a new instance of TranslateService.



47
48
49
50
51
52
 
# File 'lib/google/apis/translate_v3/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        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.

Returns:

  • (String) —

    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.



40
41
42
 
# File 'lib/google/apis/translate_v3/service.rb', line 40

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.

Returns:

  • (String) —

    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.



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

def quota_user
  @quota_user
end

Instance Method Details

#adaptive_location_mt_translate(parent, adaptive_mt_translate_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::AdaptiveMtTranslateResponse

Translate text using Adaptive MT.

Parameters:

  • parent (String) —

    Required. Location to make a regional call. Format: projects/project-number- or-id/locations/location-id``.

  • adaptive_mt_translate_request_object (Google::Apis::TranslateV3::AdaptiveMtTranslateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/google/apis/translate_v3/service.rb', line 238

def adaptive_location_mt_translate(parent, adaptive_mt_translate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:adaptiveMtTranslate', options)
  command.request_representation = Google::Apis::TranslateV3::AdaptiveMtTranslateRequest::Representation
  command.request_object = adaptive_mt_translate_request_object
  command.response_representation = Google::Apis::TranslateV3::AdaptiveMtTranslateResponse::Representation
  command.response_class = Google::Apis::TranslateV3::AdaptiveMtTranslateResponse
  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_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.

Parameters:

  • parent (String) —

    Required. Location to make a regional call. Format: projects/project-number- or-id/locations/location-id`. Theglobal` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

  • batch_translate_document_request_object (Google::Apis::TranslateV3::BatchTranslateDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/apis/translate_v3/service.rb', line 280

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', options)
  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.

Parameters:

  • parent (String) —

    Required. Location to make a call. Must refer to a caller's project. Format: projects/project-number-or-id/locations/location-id`. Theglobal` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

  • batch_translate_text_request_object (Google::Apis::TranslateV3::BatchTranslateTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/google/apis/translate_v3/service.rb', line 322

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.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::TranslateV3::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'lib/google/apis/translate_v3/service.rb', line 1790

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_adaptive_mt_dataset(parent, adaptive_mt_dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::AdaptiveMtDataset

Creates an Adaptive MT dataset.

Parameters:

  • parent (String) —

    Required. Name of the parent project. In form of projects/project-number-or- id/locations/location-id``

  • adaptive_mt_dataset_object (Google::Apis::TranslateV3::AdaptiveMtDataset) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/google/apis/translate_v3/service.rb', line 678

def create_project_location_adaptive_mt_dataset(parent, adaptive_mt_dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/adaptiveMtDatasets', options)
  command.request_representation = Google::Apis::TranslateV3::AdaptiveMtDataset::Representation
  command.request_object = adaptive_mt_dataset_object
  command.response_representation = Google::Apis::TranslateV3::AdaptiveMtDataset::Representation
  command.response_class = Google::Apis::TranslateV3::AdaptiveMtDataset
  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_dataset(parent, dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Operation

Creates a Dataset.

Parameters:

  • parent (String) —

    Required. The project name.

  • dataset_object (Google::Apis::TranslateV3::Dataset) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'lib/google/apis/translate_v3/service.rb', line 1042

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', options)
  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.

Parameters:

  • parent (String) —

    Required. The project name.

  • glossary_object (Google::Apis::TranslateV3::Glossary) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
 
# File 'lib/google/apis/translate_v3/service.rb', line 1288

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

#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.

Parameters:

  • parent (String) —

    Required. The resource name of the glossary to create the entry under.

  • glossary_entry_object (Google::Apis::TranslateV3::GlossaryEntry) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/google/apis/translate_v3/service.rb', line 1478

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', options)
  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.

Parameters:

  • parent (String) —

    Required. The project name, in form of projects/project/locations/location

  • model_object (Google::Apis::TranslateV3::Model) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'lib/google/apis/translate_v3/service.rb', line 1646

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', options)
  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_adaptive_mt_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty

Deletes an Adaptive MT dataset, including all its entries and associated metadata.

Parameters:

  • name (String) —

    Required. Name of the dataset. In the form of projects/project-number-or-id/ locations/location-id/adaptiveMtDatasets/adaptive-mt-dataset-id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



712
713
714
715
716
717
718
719
720
 
# File 'lib/google/apis/translate_v3/service.rb', line 712

def delete_project_location_adaptive_mt_dataset(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

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

Deletes an AdaptiveMtFile along with its sentences.

Parameters:

  • name (String) —

    Required. The resource name of the file to delete, in form of projects/ project-number-or-id/locations/location_id/adaptiveMtDatasets/dataset/ adaptiveMtFiles/file``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



855
856
857
858
859
860
861
862
863
 
# File 'lib/google/apis/translate_v3/service.rb', line 855

def delete_project_location_adaptive_mt_dataset_adaptive_mt_file(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

#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.

Parameters:

  • name (String) —

    Required. The name of the dataset to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/google/apis/translate_v3/service.rb', line 1074

def delete_project_location_dataset(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_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.

Parameters:

  • name (String) —

    Required. The name of the glossary to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'lib/google/apis/translate_v3/service.rb', line 1321

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_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::Empty

Deletes a single entry from the glossary

Parameters:

  • name (String) —

    Required. The resource name of the glossary entry to delete

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/google/apis/translate_v3/service.rb', line 1510

def delete_project_location_glossary_glossary_entry(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

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

Deletes a model.

Parameters:

  • name (String) —

    Required. The name of the model to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1678
1679
1680
1681
1682
1683
1684
1685
1686
 
# File 'lib/google/apis/translate_v3/service.rb', line 1678

def delete_project_location_model(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.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1825
1826
1827
1828
1829
1830
1831
1832
1833
 
# File 'lib/google/apis/translate_v3/service.rb', line 1825

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.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-id/locations/location-idor ` projects/`project-number-or-id. For global calls, use projects/project- number-or-id/locations/global or projects/project-number-or-id``. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.

  • detect_language_request_object (Google::Apis::TranslateV3::DetectLanguageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/google/apis/translate_v3/service.rb', line 360

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.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-id/locations/location-idor ` projects/`project-number-or-id. For global calls, use projects/project- number-or-id/locations/global or projects/project-number-or-id``. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.

  • detect_language_request_object (Google::Apis::TranslateV3::DetectLanguageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/google/apis/translate_v3/service.rb', line 80

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

#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.

Parameters:

  • dataset (String) —

    Required. Name of the dataset. In form of projects/project-number-or-id/ locations/location-id/datasets/dataset-id``

  • export_data_request_object (Google::Apis::TranslateV3::ExportDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/google/apis/translate_v3/service.rb', line 1106

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', options)
  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.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



392
393
394
395
396
397
398
399
400
 
# File 'lib/google/apis/translate_v3/service.rb', line 392

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_adaptive_mt_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::AdaptiveMtDataset

Gets the Adaptive MT dataset.

Parameters:

  • name (String) —

    Required. Name of the dataset. In the form of projects/project-number-or-id/ locations/location-id/adaptiveMtDatasets/adaptive-mt-dataset-id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



743
744
745
746
747
748
749
750
751
 
# File 'lib/google/apis/translate_v3/service.rb', line 743

def get_project_location_adaptive_mt_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::AdaptiveMtDataset::Representation
  command.response_class = Google::Apis::TranslateV3::AdaptiveMtDataset
  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_adaptive_mt_dataset_adaptive_mt_file(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::AdaptiveMtFile

Gets and AdaptiveMtFile

Parameters:

  • name (String) —

    Required. The resource name of the file, in form of projects/project-number- or-id/locations/location_id/adaptiveMtDatasets/dataset/adaptiveMtFiles/ file``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



887
888
889
890
891
892
893
894
895
 
# File 'lib/google/apis/translate_v3/service.rb', line 887

def get_project_location_adaptive_mt_dataset_adaptive_mt_file(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::TranslateV3::AdaptiveMtFile::Representation
  command.response_class = Google::Apis::TranslateV3::AdaptiveMtFile
  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.

Parameters:

  • name (String) —

    Required. The resource name of the dataset to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/google/apis/translate_v3/service.rb', line 1138

def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  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.

Parameters:

  • name (String) —

    Required. The name of the glossary to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1351
1352
1353
1354
1355
1356
1357
1358
1359
 
# File 'lib/google/apis/translate_v3/service.rb', line 1351

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_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.

Parameters:

  • name (String) —

    Required. The resource name of the glossary entry to get

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1540
1541
1542
1543
1544
1545
1546
1547
1548
 
# File 'lib/google/apis/translate_v3/service.rb', line 1540

def get_project_location_glossary_glossary_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  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.

Parameters:

  • name (String) —

    Required. The resource name of the model to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/google/apis/translate_v3/service.rb', line 1708

def get_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1856
1857
1858
1859
1860
1861
1862
1863
1864
 
# File 'lib/google/apis/translate_v3/service.rb', line 1856

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.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-idor `projects/`project-number-or-id`/ locations/`location-id. For global calls, use projects/project-number-or- id/locations/global or projects/project-number-or-id``. Non-global location is required for AutoML models. Only models within the same region ( have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

  • display_language_code (String) (defaults to: nil) —

    Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.

  • model (String) (defaults to: nil) —

    Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: projects/project-number-or-id/locations/ location-id/models/model-id`- General (built-in) models:projects/ project-number-or-id/locations/location-id/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/google/apis/translate_v3/service.rb', line 439

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.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-idor `projects/`project-number-or-id`/ locations/`location-id. For global calls, use projects/project-number-or- id/locations/global or projects/project-number-or-id``. Non-global location is required for AutoML models. Only models within the same region ( have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

  • display_language_code (String) (defaults to: nil) —

    Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.

  • model (String) (defaults to: nil) —

    Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: projects/project-number-or-id/locations/ location-id/models/model-id`- General (built-in) models:projects/ project-number-or-id/locations/location-id/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/apis/translate_v3/service.rb', line 129

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

#import_adaptive_mt_dataset_adaptive_mt_file(parent, import_adaptive_mt_file_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ImportAdaptiveMtFileResponse

Imports an AdaptiveMtFile and adds all of its sentences into the AdaptiveMtDataset.

Parameters:

  • parent (String) —

    Required. The resource name of the file, in form of projects/project-number- or-id/locations/location_id/adaptiveMtDatasets/dataset``

  • import_adaptive_mt_file_request_object (Google::Apis::TranslateV3::ImportAdaptiveMtFileRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/google/apis/translate_v3/service.rb', line 776

def import_adaptive_mt_dataset_adaptive_mt_file(parent, import_adaptive_mt_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:importAdaptiveMtFile', options)
  command.request_representation = Google::Apis::TranslateV3::ImportAdaptiveMtFileRequest::Representation
  command.request_object = import_adaptive_mt_file_request_object
  command.response_representation = Google::Apis::TranslateV3::ImportAdaptiveMtFileResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ImportAdaptiveMtFileResponse
  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

#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.

Parameters:

  • dataset (String) —

    Required. Name of the dataset. In form of projects/project-number-or-id/ locations/location-id/datasets/dataset-id``

  • import_data_request_object (Google::Apis::TranslateV3::ImportDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/google/apis/translate_v3/service.rb', line 1170

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', options)
  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_adaptive_mt_dataset_adaptive_mt_file_adaptive_mt_sentences(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListAdaptiveMtSentencesResponse

Lists all AdaptiveMtSentences under a given file/dataset.

Parameters:

  • parent (String) —

    Required. The resource name of the Adaptive MT file from which to list the sentences. The following format lists all sentences under a file. projects/ project/locations/location/adaptiveMtDatasets/dataset/adaptiveMtFiles/ fileThe following format lists all sentences within a dataset. `projects/` project`/locations/`location`/adaptiveMtDatasets/`dataset

  • page_size (Fixnum) (defaults to: nil)
  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of ListAdaptiveMtSentencesRequest.next_page_token returned from the previous call to ListTranslationMemories method. The first page is returned if page_token is empty or missing.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/google/apis/translate_v3/service.rb', line 967

def list_project_location_adaptive_mt_dataset_adaptive_mt_file_adaptive_mt_sentences(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/adaptiveMtSentences', options)
  command.response_representation = Google::Apis::TranslateV3::ListAdaptiveMtSentencesResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListAdaptiveMtSentencesResponse
  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_adaptive_mt_dataset_adaptive_mt_files(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListAdaptiveMtFilesResponse

Lists all AdaptiveMtFiles associated to an AdaptiveMtDataset.

Parameters:

  • parent (String) —

    Required. The resource name of the dataset from which to list the Adaptive MT files. projects/project/locations/location/adaptiveMtDatasets/dataset``

  • page_size (Fixnum) (defaults to: nil) —

    Optional.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of ListAdaptiveMtFilesResponse.next_page_token returned from the previous call to ListAdaptiveMtFiles method. The first page is returned if page_tokenis empty or missing.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/google/apis/translate_v3/service.rb', line 925

def list_project_location_adaptive_mt_dataset_adaptive_mt_files(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/adaptiveMtFiles', options)
  command.response_representation = Google::Apis::TranslateV3::ListAdaptiveMtFilesResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListAdaptiveMtFilesResponse
  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_adaptive_mt_dataset_adaptive_mt_sentences(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListAdaptiveMtSentencesResponse

Lists all AdaptiveMtSentences under a given file/dataset.

Parameters:

  • parent (String) —

    Required. The resource name of the Adaptive MT file from which to list the sentences. The following format lists all sentences under a file. projects/ project/locations/location/adaptiveMtDatasets/dataset/adaptiveMtFiles/ fileThe following format lists all sentences within a dataset. `projects/` project`/locations/`location`/adaptiveMtDatasets/`dataset

  • page_size (Fixnum) (defaults to: nil)
  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of ListAdaptiveMtSentencesRequest.next_page_token returned from the previous call to ListTranslationMemories method. The first page is returned if page_token is empty or missing.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/translate_v3/service.rb', line 1009

def list_project_location_adaptive_mt_dataset_adaptive_mt_sentences(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/adaptiveMtSentences', options)
  command.response_representation = Google::Apis::TranslateV3::ListAdaptiveMtSentencesResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListAdaptiveMtSentencesResponse
  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_adaptive_mt_datasets(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::ListAdaptiveMtDatasetsResponse

Lists all Adaptive MT datasets for which the caller has read permission.

Parameters:

  • parent (String) —

    Required. The resource name of the project from which to list the Adaptive MT datasets. projects/project-number-or-id/locations/location-id``

  • filter (String) (defaults to: nil) —

    Optional. An expression for filtering the results of the request. Filter is not supported yet.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server may return fewer results than requested. If unspecified, the server picks an appropriate default.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of ListAdaptiveMtDatasetsResponse.next_page_token returned from the previous call to ListAdaptiveMtDatasets method. The first page is returned if page_tokenis empty or missing.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/google/apis/translate_v3/service.rb', line 820

def list_project_location_adaptive_mt_datasets(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+parent}/adaptiveMtDatasets', options)
  command.response_representation = Google::Apis::TranslateV3::ListAdaptiveMtDatasetsResponse::Representation
  command.response_class = Google::Apis::TranslateV3::ListAdaptiveMtDatasetsResponse
  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_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.

Parameters:

  • parent (String) —

    Required. Name of the parent dataset. In form of projects/project-number-or- id/locations/location-id/datasets/dataset-id``

  • filter (String) (defaults to: nil) —

    Optional. An expression for filtering the examples that will be returned. Example filter: * usage=TRAIN

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server can return fewer results than requested.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results for the server to return. Typically obtained from next_page_token field in the response of a ListExamples call.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
 
# File 'lib/google/apis/translate_v3/service.rb', line 1253

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', options)
  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.

Parameters:

  • parent (String) —

    Required. Name of the parent project. In form of projects/project-number-or- id/locations/location-id``

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server can return fewer results than requested.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results for the server to return. Typically obtained from next_page_token field in the response of a ListDatasets call.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/apis/translate_v3/service.rb', line 1210

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', options)
  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.

Parameters:

  • parent (String) —

    Required. The name of the project from which to list all of the glossaries.

  • filter (String) (defaults to: nil) —

    Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en- US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to ListGlossaries method. The first page is returned if page_tokenis empty or missing.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'lib/google/apis/translate_v3/service.rb', line 1404

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_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.

Parameters:

  • parent (String) —

    Required. The parent glossary resource name for listing the glossary's entries.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server may return fewer glossary entries than requested. If unspecified, the server picks an appropriate default.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossaryEntriesResponse.next_page_token] returned from the previous call. The first page is returned if page_tokenis empty or missing.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
 
# File 'lib/google/apis/translate_v3/service.rb', line 1578

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', options)
  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.

Parameters:

  • parent (String) —

    Required. Name of the parent project. In form of projects/project-number-or- id/locations/location-id``

  • filter (String) (defaults to: nil) —

    Optional. An expression for filtering the models that will be returned. Supported filter: dataset_id=$dataset_id``

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server can return fewer results than requested.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results for the server to return. Typically obtained from next_page_token field in the response of a ListModels call.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'lib/google/apis/translate_v3/service.rb', line 1749

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', options)
  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, return_partial_success: 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.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/google/apis/translate_v3/service.rb', line 1901

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: 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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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, extra_location_types: nil, 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. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil) —

    Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.

  • filter (String) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil) —

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/google/apis/translate_v3/service.rb', line 493

def list_project_locations(name, extra_location_types: nil, 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['extraLocationTypes'] = extra_location_types unless extra_location_types.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.

Parameters:

  • name (String) —

    Identifier. The resource name of the glossary. Glossary names have the form projects/project-number-or-id/locations/location-id/glossaries/glossary- id``.

  • glossary_object (Google::Apis::TranslateV3::Glossary) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated. Currently, only display_name and input_config are supported.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/google/apis/translate_v3/service.rb', line 1444

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}', 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['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.

Parameters:

  • name (String) —

    Identifier. The resource name of the entry. Format: projects/*/locations/*/ glossaries/*/glossaryEntries/*

  • glossary_entry_object (Google::Apis::TranslateV3::GlossaryEntry) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/google/apis/translate_v3/service.rb', line 1612

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}', options)
  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

#refine_location_text(parent, refine_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::RefineTextResponse

Refines the input translated text to improve the quality.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-id/locations/location-id. For global calls, use `projects/`project-number-or-id`/locations/global` or `projects/` project-number-or-id.

  • refine_text_request_object (Google::Apis::TranslateV3::RefineTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/google/apis/translate_v3/service.rb', line 531

def refine_location_text(parent, refine_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:refineText', options)
  command.request_representation = Google::Apis::TranslateV3::RefineTextRequest::Representation
  command.request_object = refine_text_request_object
  command.response_representation = Google::Apis::TranslateV3::RefineTextResponse::Representation
  command.response_class = Google::Apis::TranslateV3::RefineTextResponse
  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

#romanize_location_text(parent, romanize_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::RomanizeTextResponse

Romanize input text written in non-Latin scripts to Latin text.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-id/locations/location-idor ` projects/`project-number-or-id. For global calls, use projects/project- number-or-id/locations/global or projects/project-number-or-id``.

  • romanize_text_request_object (Google::Apis::TranslateV3::RomanizeTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/google/apis/translate_v3/service.rb', line 567

def romanize_location_text(parent, romanize_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:romanizeText', options)
  command.request_representation = Google::Apis::TranslateV3::RomanizeTextRequest::Representation
  command.request_object = romanize_text_request_object
  command.response_representation = Google::Apis::TranslateV3::RomanizeTextResponse::Representation
  command.response_class = Google::Apis::TranslateV3::RomanizeTextResponse
  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

#romanize_project_text(parent, romanize_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV3::RomanizeTextResponse

Romanize input text written in non-Latin scripts to Latin text.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-id/locations/location-idor ` projects/`project-number-or-id. For global calls, use projects/project- number-or-id/locations/global or projects/project-number-or-id``.

  • romanize_text_request_object (Google::Apis::TranslateV3::RomanizeTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/google/apis/translate_v3/service.rb', line 165

def romanize_project_text(parent, romanize_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}:romanizeText', options)
  command.request_representation = Google::Apis::TranslateV3::RomanizeTextRequest::Representation
  command.request_object = romanize_text_request_object
  command.response_representation = Google::Apis::TranslateV3::RomanizeTextResponse::Representation
  command.response_class = Google::Apis::TranslateV3::RomanizeTextResponse
  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_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.

Parameters:

  • parent (String) —

    Required. Location to make a regional call. Format: projects/project-number- or-id/locations/location-id. For global calls, use `projects/`project- number-or-id`/locations/global` or `projects/`project-number-or-id. Non- global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have the same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

  • translate_document_request_object (Google::Apis::TranslateV3::TranslateDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/google/apis/translate_v3/service.rb', line 605

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', options)
  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.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-idor `projects/`project-number-or-id`/ locations/`location-id. For global calls, use projects/project-number-or- id/locations/global or projects/project-number-or-id``. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

  • translate_text_request_object (Google::Apis::TranslateV3::TranslateTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/google/apis/translate_v3/service.rb', line 644

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.

Parameters:

  • parent (String) —

    Required. Project or location to make a call. Must refer to a caller's project. Format: projects/project-number-or-idor `projects/`project-number-or-id`/ locations/`location-id. For global calls, use projects/project-number-or- id/locations/global or projects/project-number-or-id``. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

  • translate_text_request_object (Google::Apis::TranslateV3::TranslateTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/apis/translate_v3/service.rb', line 204

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 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.

Parameters:

  • name (String) —

    The name of the operation resource to wait on.

  • wait_operation_request_object (Google::Apis::TranslateV3::WaitOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/google/apis/translate_v3/service.rb', line 1943

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