Class: OCI::Streaming::Models::PutMessagesResult

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

Overview

The response to a put_messages request. It indicates the number of failed messages as well as an array of results for successful and failed messages.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PutMessagesResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

Instance Attribute Details

#entries ⇒ Array<OCI::Streaming::Models::PutMessagesResultEntry>

An array of items representing the result of each message. The order is guaranteed to be the same as in the ‘PutMessagesDetails` object. If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`. If a message failed to be appended to the stream, the entry includes the `error` and `errorMessage`.

Returns:



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

def entries
  @entries
end

#failures ⇒ Integer

[Required] The number of messages that failed to be added to the stream.

Returns:

  • (Integer) 


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

def failures
  @failures
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'failures': :'failures',
    'entries': :'entries'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'failures': :'Integer',
    'entries': :'Array<OCI::Streaming::Models::PutMessagesResultEntry>'
    # 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



69
70
71
72
73
74
75
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 69

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

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 100

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


80
81
82
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 80

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



89
90
91
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 89

def hash
  [failures, entries].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 133

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



127
128
129
 
# File 'lib/oci/streaming/models/put_messages_result.rb', line 127

def to_s
  to_hash.to_s
end