Class: OCI::Streaming::Models::PutMessagesResultEntry

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

Overview

Represents the result of a put_messages request, whether it was successful or not. If a message was successfully appended to the stream, the entry includes the ‘offset`, `partition`, and `timestamp`. If the message failed to be appended to the stream, the entry includes the `error` and `errorMessage`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PutMessagesResultEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :partition (String) —

    The value to assign to the #partition property

  • :offset (Integer) —

    The value to assign to the #offset property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property

  • :error (String) —

    The value to assign to the #error property

  • :error_message (String) —

    The value to assign to the #error_message property



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 69

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

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

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

Instance Attribute Details

#error ⇒ String

The error code, in case the message was not successfully appended to the stream.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 26

def error
  @error
end

#error_message ⇒ String

A human-readable error message associated with the error code.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 30

def error_message
  @error_message
end

#offset ⇒ Integer

The offset of the message in the partition.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 18

def offset
  @offset
end

#partition ⇒ String

The ID of the partition where the message was stored.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 14

def partition
  @partition
end

#timestamp ⇒ DateTime

The timestamp indicating when the server appended the message to the stream.

Returns:

  • (DateTime) 


22
23
24
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 22

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'partition': :'partition',
    'offset': :'offset',
    'timestamp': :'timestamp',
    'error': :'error',
    'error_message': :'errorMessage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 46

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



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 97

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

  self.class == other.class &&
    partition == other.partition &&
    offset == other.offset &&
    timestamp == other.timestamp &&
    error == other.error &&
    error_message == other.error_message
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 131

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


111
112
113
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 120

def hash
  [partition, offset, timestamp, error, error_message].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 164

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



158
159
160
 
# File 'lib/oci/streaming/models/put_messages_result_entry.rb', line 158

def to_s
  to_hash.to_s
end