Class: OCI::AiSpeech::Models::TtsAudioConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_speech/models/tts_audio_config.rb

Overview

Use this schema to specify handling of audio response. If audioConfig is not provided, raw response is handed over for the user to handle.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

TtsBaseAudioConfig

Constant Summary collapse

CONFIG_TYPE_ENUM = 
[
  CONFIG_TYPE_BASE_AUDIO_CONFIG = 'BASE_AUDIO_CONFIG'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TtsAudioConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :config_type (String) —

    The value to assign to the #config_type property



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 65

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

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

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

Instance Attribute Details

#config_type ⇒ String

[Required] The audio config type to use for handling the audio output. Supported config types are: - BASE_AUDIO_CONFIG

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 23

def config_type
  @config_type
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'configType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



48
49
50
51
52
53
54
55
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 48

def self.get_subtype(object_hash)
  type = object_hash[:'configType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AiSpeech::Models::TtsBaseAudioConfig' if type == 'BASE_AUDIO_CONFIG'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AiSpeech::Models::TtsAudioConfig'
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'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



93
94
95
96
97
98
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 93

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

  self.class == other.class &&
    config_type == other.config_type
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 123

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


103
104
105
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 112

def hash
  [config_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 156

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



150
151
152
 
# File 'lib/oci/ai_speech/models/tts_audio_config.rb', line 150

def to_s
  to_hash.to_s
end