class OCI::Streaming::Models::PutMessagesResultEntry
Represents the result of a {#put_messages 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`.
Attributes
The error code, in case the message was not successfully appended to the stream. @return [String]
A human-readable error message associated with the error code. @return [String]
The offset of the message in the partition. @return [Integer]
The ID of the partition where the message was stored. @return [String]
The timestamp indicating when the server appended the message to the stream. @return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :partition The value to assign to the {#partition} property @option attributes [Integer] :offset The value to assign to the {#offset} property @option attributes [DateTime] :timestamp The value to assign to the {#timestamp} property @option attributes [String] :error The value to assign to the {#error} property @option attributes [String] :error_message The value to assign to the {#error_message} property
# 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
Attribute type mapping.
# 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
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_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
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_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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/streaming/models/put_messages_result_entry.rb, line 112 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_entry.rb, line 121 def hash [partition, offset, timestamp, error, error_message].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_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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/streaming/models/put_messages_result_entry.rb, line 159 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_entry.rb, line 182 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