Class: OCI::Queue::Models::DeleteMessagesResult
- Inherits:
-
Object
- Object
- OCI::Queue::Models::DeleteMessagesResult
- Defined in:
- lib/oci/queue/models/delete_messages_result.rb
Overview
The response to a DeleteMessages request. It indicates the number of server and client failures as well as an array of entries for successful and failed actions.
Instance Attribute Summary collapse
-
#client_failures ⇒ Integer
[Required] The number of messages that failed to be deleted from the queue because of a client failure such as an invalid receipt.
-
#entries ⇒ Array<OCI::Queue::Models::DeleteMessagesResultEntry>
[Required] An array of items representing the result of each action.
-
#server_failures ⇒ Integer
[Required] The number of messages that failed to be deleted from the queue because of a server failure.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DeleteMessagesResult
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ DeleteMessagesResult
Initializes the object
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 58 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.server_failures = attributes[:'serverFailures'] if attributes[:'serverFailures'] raise 'You cannot provide both :serverFailures and :server_failures' if attributes.key?(:'serverFailures') && attributes.key?(:'server_failures') self.server_failures = attributes[:'server_failures'] if attributes[:'server_failures'] self.client_failures = attributes[:'clientFailures'] if attributes[:'clientFailures'] raise 'You cannot provide both :clientFailures and :client_failures' if attributes.key?(:'clientFailures') && attributes.key?(:'client_failures') self.client_failures = attributes[:'client_failures'] if attributes[:'client_failures'] self.entries = attributes[:'entries'] if attributes[:'entries'] end |
Instance Attribute Details
#client_failures ⇒ Integer
[Required] The number of messages that failed to be deleted from the queue because of a client failure such as an invalid receipt.
17 18 19 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 17 def client_failures @client_failures end |
#entries ⇒ Array<OCI::Queue::Models::DeleteMessagesResultEntry>
[Required] An array of items representing the result of each action. The order is guaranteed to be the same as in the DeleteMessagesDetails
object. If a message was successfully deleted from the queue, the entry does not contain any fields. If a message failed to be deleted from the queue, the entry includes the errorCode
and errorMessage
fields.
25 26 27 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 25 def entries @entries end |
#server_failures ⇒ Integer
[Required] The number of messages that failed to be deleted from the queue because of a server failure.
13 14 15 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 13 def server_failures @server_failures end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
28 29 30 31 32 33 34 35 36 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 28 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'server_failures': :'serverFailures', 'client_failures': :'clientFailures', 'entries': :'entries' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
39 40 41 42 43 44 45 46 47 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 39 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'server_failures': :'Integer', 'client_failures': :'Integer', 'entries': :'Array<OCI::Queue::Models::DeleteMessagesResultEntry>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
86 87 88 89 90 91 92 93 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 86 def ==(other) return true if equal?(other) self.class == other.class && server_failures == other.server_failures && client_failures == other.client_failures && entries == other.entries end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 118 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
98 99 100 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 98 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
107 108 109 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 107 def hash [server_failures, client_failures, entries].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
151 152 153 154 155 156 157 158 159 160 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 151 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
145 146 147 |
# File 'lib/oci/queue/models/delete_messages_result.rb', line 145 def to_s to_hash.to_s end |