Class: OCI::Queue::Models::Stats

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

Overview

The stats for a queue or a dead letter queue.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Stats

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :visible_messages (Integer) —

    The value to assign to the #visible_messages property

  • :in_flight_messages (Integer) —

    The value to assign to the #in_flight_messages property

  • :size_in_bytes (Integer) —

    The value to assign to the #size_in_bytes property



54
55
56
57
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/stats.rb', line 54

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

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

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

  self.in_flight_messages = attributes[:'inFlightMessages'] if attributes[:'inFlightMessages']

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

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

  self.size_in_bytes = attributes[:'sizeInBytes'] if attributes[:'sizeInBytes']

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

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

Instance Attribute Details

#in_flight_messages ⇒ Integer

[Required] The approximate number of messages delivered to a consumer but not yet deleted and so unavailable for re-delivery.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/queue/models/stats.rb', line 17

def in_flight_messages
  @in_flight_messages
end

#size_in_bytes ⇒ Integer

[Required] The approximate size of the queue in bytes. Sum of the size of visible and in-flight messages.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/queue/models/stats.rb', line 21

def size_in_bytes
  @size_in_bytes
end

#visible_messages ⇒ Integer

[Required] The approximate number of visible messages (available for delivery) currently in the queue.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/queue/models/stats.rb', line 13

def visible_messages
  @visible_messages
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
32
 
# File 'lib/oci/queue/models/stats.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'visible_messages': :'visibleMessages',
    'in_flight_messages': :'inFlightMessages',
    'size_in_bytes': :'sizeInBytes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'visible_messages': :'Integer',
    'in_flight_messages': :'Integer',
    'size_in_bytes': :'Integer'
    # 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



86
87
88
89
90
91
92
93
 
# File 'lib/oci/queue/models/stats.rb', line 86

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

  self.class == other.class &&
    visible_messages == other.visible_messages &&
    in_flight_messages == other.in_flight_messages &&
    size_in_bytes == other.size_in_bytes
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



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/stats.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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


98
99
100
 
# File 'lib/oci/queue/models/stats.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/queue/models/stats.rb', line 107

def hash
  [visible_messages, in_flight_messages, size_in_bytes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/queue/models/stats.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

Returns:

  • (String) —

    String presentation of the object



145
146
147
 
# File 'lib/oci/queue/models/stats.rb', line 145

def to_s
  to_hash.to_s
end