Class: OCI::Queue::Models::UpdateMessagesResultEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/queue/models/update_messages_result_entry.rb

Overview

Represents the result of a UpdateMessages request, whether it was successful or not. If a message was successfully updated in the queue, the entry includes the id and visibleAfter fields. If a message failed to be updated in the queue, the entry includes the errorCode and errorMessage fields.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateMessagesResultEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (Integer) —

    The value to assign to the #id property

  • :visible_after (DateTime) —

    The value to assign to the #visible_after property

  • :error_code (Integer) —

    The value to assign to the #error_code property

  • :error_message (String) —

    The value to assign to the #error_message property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 67

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

  self.visible_after = attributes[:'visibleAfter'] if attributes[:'visibleAfter']

  raise 'You cannot provide both :visibleAfter and :visible_after' if attributes.key?(:'visibleAfter') && attributes.key?(:'visible_after')

  self.visible_after = attributes[:'visible_after'] if attributes[:'visible_after']

  self.error_code = attributes[:'errorCode'] if attributes[:'errorCode']

  raise 'You cannot provide both :errorCode and :error_code' if attributes.key?(:'errorCode') && attributes.key?(:'error_code')

  self.error_code = attributes[:'error_code'] if attributes[:'error_code']

  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

#error_code ⇒ Integer

The error code, in case the message was not successfully updated in the queue.

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 27

def error_code
  @error_code
end

#error_message ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 31

def error_message
  @error_message
end

#id ⇒ Integer

The ID of the message that's been updated.

Returns:

  • (Integer) 


16
17
18
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 16

def id
  @id
end

#visible_after ⇒ DateTime

The time after which the message will be visible to other consumers, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:

  • (DateTime) 


23
24
25
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 23

def visible_after
  @visible_after
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'visible_after': :'visibleAfter',
    'error_code': :'errorCode',
    'error_message': :'errorMessage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'Integer',
    'visible_after': :'DateTime',
    'error_code': :'Integer',
    '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



101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 101

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

  self.class == other.class &&
    id == other.id &&
    visible_after == other.visible_after &&
    error_code == other.error_code &&
    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



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

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


114
115
116
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 123

def hash
  [id, visible_after, error_code, error_message].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 167

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



161
162
163
 
# File 'lib/oci/queue/models/update_messages_result_entry.rb', line 161

def to_s
  to_hash.to_s
end