Class: OCI::Oda::Models::CreateTranslatorDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/models/create_translator_details.rb

Overview

Properties that are required to create a Translator.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_GOOGLE = 'GOOGLE'.freeze,
  TYPE_MICROSOFT = 'MICROSOFT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTranslatorDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :base_url (String) —

    The value to assign to the #base_url property

  • :auth_token (String) —

    The value to assign to the #auth_token property

  • :properties (Hash<String, String>) —

    The value to assign to the #properties property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

[View source]

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 86

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.type = attributes[:'type'] if attributes[:'type']

  self.base_url = attributes[:'baseUrl'] if attributes[:'baseUrl']

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

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

  self.auth_token = attributes[:'authToken'] if attributes[:'authToken']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#auth_token ⇒ String

[Required] The authentication token to use when invoking the Translation Service

Returns:

  • (String) 

26
27
28
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 26

def auth_token
  @auth_token
end

#base_url ⇒ String

[Required] The base URL for invoking the Translation Service.

Returns:

  • (String) 

22
23
24
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 22

def base_url
  @base_url
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 

44
45
46
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 44

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 

38
39
40
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 38

def freeform_tags
  @freeform_tags
end

#properties ⇒ Hash<String, String>

Properties used when invoking the translation service. Each property is a simple key-value pair.

Returns:

  • (Hash<String, String>) 

32
33
34
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 32

def properties
  @properties
end

#type ⇒ String

[Required] The Translation Service to use for this Translator.

Returns:

  • (String) 

18
19
20
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 18

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'base_url': :'baseUrl',
    'auth_token': :'authToken',
    'properties': :'properties',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'base_url': :'String',
    'auth_token': :'String',
    'properties': :'Hash<String, String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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

[View source]

136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 136

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

  self.class == other.class &&
    type == other.type &&
    base_url == other.base_url &&
    auth_token == other.auth_token &&
    properties == other.properties &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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

[View source]

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 171

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
[View source]

151
152
153
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 151

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

160
161
162
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 160

def hash
  [type, base_url, auth_token, properties, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 204

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

[View source]

198
199
200
 
# File 'lib/oci/oda/models/create_translator_details.rb', line 198

def to_s
  to_hash.to_s
end