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



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

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

#errorString

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

Returns:

  • (String)


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

def error
  @error
end

#error_messageString

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

Returns:

  • (String)


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

def error_message
  @error_message
end

#offsetInteger

The offset of the message in the partition.

Returns:

  • (Integer)


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

def offset
  @offset
end

#partitionString

The ID of the partition where the message was stored.

Returns:

  • (String)


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

def partition
  @partition
end

#timestampDateTime

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

Returns:

  • (DateTime)


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

def timestamp
  @timestamp
end

Class Method Details

.attribute_mapObject

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



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

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_typesObject

Attribute type mapping.



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

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



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

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



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

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


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

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

def to_s
  to_hash.to_s
end