Class: Google::Apis::TranslateV2::TranslateTextRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/translate_v2/classes.rb,
generated/google/apis/translate_v2/representations.rb,
generated/google/apis/translate_v2/representations.rb

Overview

The main translation request message for the Cloud Translation API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TranslateTextRequest

Returns a new instance of TranslateTextRequest



201
202
203
 
# File 'generated/google/apis/translate_v2/classes.rb', line 201

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#format ⇒ String

The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text. Corresponds to the JSON property format

Returns:

  • (String) 


173
174
175
 
# File 'generated/google/apis/translate_v2/classes.rb', line 173

def format
  @format
end

#model ⇒ String

The model type requested for this translation. Valid values are listed in public documentation. Corresponds to the JSON property model

Returns:

  • (String) 


179
180
181
 
# File 'generated/google/apis/translate_v2/classes.rb', line 179

def model
  @model
end

#q ⇒ Array<String>

The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs. Corresponds to the JSON property q

Returns:

  • (Array<String>) 


185
186
187
 
# File 'generated/google/apis/translate_v2/classes.rb', line 185

def q
  @q
end

#source ⇒ String

The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response. Corresponds to the JSON property source

Returns:

  • (String) 


193
194
195
 
# File 'generated/google/apis/translate_v2/classes.rb', line 193

def source
  @source
end

#target ⇒ String

The language to use for translation of the input text, set to one of the language codes listed in Language Support. Corresponds to the JSON property target

Returns:

  • (String) 


199
200
201
 
# File 'generated/google/apis/translate_v2/classes.rb', line 199

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



206
207
208
209
210
211
212
 
# File 'generated/google/apis/translate_v2/classes.rb', line 206

def update!(**args)
  @format = args[:format] if args.key?(:format)
  @model = args[:model] if args.key?(:model)
  @q = args[:q] if args.key?(:q)
  @source = args[:source] if args.key?(:source)
  @target = args[:target] if args.key?(:target)
end