class OCI::Streaming::Models::PutMessagesResult
The response to a {#put_messages put_messages} request. It indicates the number of failed messages as well as an array of results for successful and failed messages.
Attributes
[Required] 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`.
@return [Array<OCI::Streaming::Models::PutMessagesResultEntry>]
[Required] The number of messages that failed to be added to the stream. @return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/streaming/models/put_messages_result.rb, line 25 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'failures': :'failures', 'entries': :'entries' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :failures The value to assign to the {#failures} property @option attributes [Array<OCI::Streaming::Models::PutMessagesResultEntry>] :entries The value to assign to the {#entries} property
# File lib/oci/streaming/models/put_messages_result.rb, line 52 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
Attribute type mapping.
# File lib/oci/streaming/models/put_messages_result.rb, line 35 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'failures': :'Integer', 'entries': :'Array<OCI::Streaming::Models::PutMessagesResultEntry>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/streaming/models/put_messages_result.rb, line 70 def ==(other) return true if equal?(other) self.class == other.class && failures == other.failures && entries == other.entries end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/streaming/models/put_messages_result.rb, line 101 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/streaming/models/put_messages_result.rb, line 81 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/streaming/models/put_messages_result.rb, line 90 def hash [failures, entries].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/streaming/models/put_messages_result.rb, line 134 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/streaming/models/put_messages_result.rb, line 128 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/streaming/models/put_messages_result.rb, line 151 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end