Class: OCI::Streaming::Models::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/streaming/models/message.rb

Overview

A message in a stream.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :stream (String) —

    The value to assign to the #stream property

  • :partition (String) —

    The value to assign to the #partition property

  • :key (String) —

    The value to assign to the #key property

  • :value (String) —

    The value to assign to the #value property

  • :offset (Integer) —

    The value to assign to the #offset property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/streaming/models/message.rb', line 75

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

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

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

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

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

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

Instance Attribute Details

#key ⇒ String

[Required] The key associated with the message, expressed as a byte array.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/streaming/models/message.rb', line 21

def key
  @key
end

#offset ⇒ Integer

[Required] The offset of the message, which uniquely identifies it within the partition.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/streaming/models/message.rb', line 29

def offset
  @offset
end

#partition ⇒ String

[Required] The ID of the partition where the message is stored.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/streaming/models/message.rb', line 17

def partition
  @partition
end

#stream ⇒ String

[Required] The name of the stream that the message belongs to.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/streaming/models/message.rb', line 13

def stream
  @stream
end

#timestamp ⇒ DateTime

[Required] The timestamp indicating when the server appended the message to the stream.

Returns:

  • (DateTime) 


33
34
35
 
# File 'lib/oci/streaming/models/message.rb', line 33

def timestamp
  @timestamp
end

#value ⇒ String

[Required] The value associated with the message, expressed as a byte array.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/streaming/models/message.rb', line 25

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/streaming/models/message.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'stream': :'stream',
    'partition': :'partition',
    'key': :'key',
    'value': :'value',
    'offset': :'offset',
    'timestamp': :'timestamp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/streaming/models/message.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'stream': :'String',
    'partition': :'String',
    'key': :'String',
    'value': :'String',
    'offset': :'Integer',
    'timestamp': :'DateTime'
    # 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



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/streaming/models/message.rb', line 101

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

  self.class == other.class &&
    stream == other.stream &&
    partition == other.partition &&
    key == other.key &&
    value == other.value &&
    offset == other.offset &&
    timestamp == other.timestamp
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/streaming/models/message.rb', line 136

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


116
117
118
 
# File 'lib/oci/streaming/models/message.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/streaming/models/message.rb', line 125

def hash
  [stream, partition, key, value, offset, timestamp].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/streaming/models/message.rb', line 169

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



163
164
165
 
# File 'lib/oci/streaming/models/message.rb', line 163

def to_s
  to_hash.to_s
end