Class: OCI::AiSpeech::Models::RealtimeMessage

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

Overview

Websocket messages sent between client and service. 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

Constant Summary collapse

EVENT_ENUM = 
[
  EVENT_RESULT = 'RESULT'.freeze,
  EVENT_ACKAUDIO = 'ACKAUDIO'.freeze,
  EVENT_ERROR = 'ERROR'.freeze,
  EVENT_CONNECT = 'CONNECT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RealtimeMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :event (String) —

    The value to assign to the #event property

  • :session_id (String) —

    The value to assign to the #session_id property



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 80

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

  self.session_id = attributes[:'sessionId'] if attributes[:'sessionId']

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

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

Instance Attribute Details

#event ⇒ String

[Required] Incoming Types of message event sent from Service -> Client - RESULT - result - ACKAUDIO - ackAudio - ERROR - error - CONNECT - connect Outgoing Types of message event sent from Client -> Service - SEND_FINAL_RESULT - sendFinalResult

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 28

def event
  @event
end

#session_id ⇒ String

Session ID for the connected session.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 32

def session_id
  @session_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'event': :'event',
    'session_id': :'sessionId'
    # 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.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 59

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

  return 'OCI::AiSpeech::Models::RealtimeMessageError' if type == 'ERROR'
  return 'OCI::AiSpeech::Models::RealtimeMessageAckAudio' if type == 'ACKAUDIO'
  return 'OCI::AiSpeech::Models::RealtimeMessageConnect' if type == 'CONNECT'
  return 'OCI::AiSpeech::Models::RealtimeMessageResult' if type == 'RESULT'

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

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 45

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



110
111
112
113
114
115
116
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 110

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

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 141

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


121
122
123
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 130

def hash
  [event, session_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 174

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



168
169
170
 
# File 'lib/oci/ai_speech/models/realtime_message.rb', line 168

def to_s
  to_hash.to_s
end