Class: OCI::AiLanguage::Models::TranslationDocumentResult

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/translation_document_result.rb

Overview

The document response for translation call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TranslationDocumentResult

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :translated_text (String) —

    The value to assign to the #translated_text property

  • :source_language_code (String) —

    The value to assign to the #source_language_code property

  • :target_language_code (String) —

    The value to assign to the #target_language_code property



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 126

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.key = attributes[:'key'] if attributes[:'key']

  self.translated_text = attributes[:'translatedText'] if attributes[:'translatedText']

  raise 'You cannot provide both :translatedText and :translated_text' if attributes.key?(:'translatedText') && attributes.key?(:'translated_text')

  self.translated_text = attributes[:'translated_text'] if attributes[:'translated_text']

  self.source_language_code = attributes[:'sourceLanguageCode'] if attributes[:'sourceLanguageCode']

  raise 'You cannot provide both :sourceLanguageCode and :source_language_code' if attributes.key?(:'sourceLanguageCode') && attributes.key?(:'source_language_code')

  self.source_language_code = attributes[:'source_language_code'] if attributes[:'source_language_code']

  self.target_language_code = attributes[:'targetLanguageCode'] if attributes[:'targetLanguageCode']

  raise 'You cannot provide both :targetLanguageCode and :target_language_code' if attributes.key?(:'targetLanguageCode') && attributes.key?(:'target_language_code')

  self.target_language_code = attributes[:'target_language_code'] if attributes[:'target_language_code']
end

Instance Attribute Details

#key ⇒ String

[Required] Document unique identifier defined by the user.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 13

def key
  @key
end

#source_language_code ⇒ String

[Required] Language code supported Automatically detect language - auto Arabic - ar Brazilian Portuguese - pt-BR Canadian French - fr-CA Croatian - hr Czech - cs Danish - da Dutch - nl English - en Finnish - fi French - fr German - de Greek - el Hebrew - he Hungarian - hu Italian - it Japanese - ja Korean - ko Norwegian - no Polish - pl Portuguese - pt Romanian - ro Russian - ru Simplified Chinese - zh-CN Slovak - sk Slovenian - sl Spanish - es Swedish - sv Thai - th Traditional Chinese - zh-TW Turkish - tr Vietnamese - vi

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 54

def source_language_code
  @source_language_code
end

#target_language_code ⇒ String

[Required] Language code supported Arabic - ar Brazilian Portuguese - pt-BR Canadian French - fr-CA Croatian - hr Czech - cs Danish - da Dutch - nl English - en Finnish - fi French - fr German - de Greek - el Hebrew - he Hungarian - hu Italian - it Japanese - ja Korean - ko Norwegian - no Polish - pl Portuguese - pt Romanian - ro Russian - ru Simplified Chinese - zh-CN Slovak - sk Slovenian - sl Spanish - es Swedish - sv Thai - th Traditional Chinese - zh-TW Turkish - tr Vietnamese - vi

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 90

def target_language_code
  @target_language_code
end

#translated_text ⇒ String

[Required] Translated text in selected target language.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 17

def translated_text
  @translated_text
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'translated_text': :'translatedText',
    'source_language_code': :'sourceLanguageCode',
    'target_language_code': :'targetLanguageCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 105

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'translated_text': :'String',
    'source_language_code': :'String',
    'target_language_code': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 160

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    translated_text == other.translated_text &&
    source_language_code == other.source_language_code &&
    target_language_code == other.target_language_code
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 193

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 182

def hash
  [key, translated_text, source_language_code, target_language_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 226

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



220
221
222
 
# File 'lib/oci/ai_language/models/translation_document_result.rb', line 220

def to_s
  to_hash.to_s
end