Class: OCI::Streaming::Models::PartitionReservation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/streaming/models/partition_reservation.rb

Overview

Represents the state of a single partition reservation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartitionReservation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :partition (String) —

    The value to assign to the #partition property

  • :committed_offset (Integer) —

    The value to assign to the #committed_offset property

  • :reserved_instance (String) —

    The value to assign to the #reserved_instance property

  • :time_reserved_until (DateTime) —

    The value to assign to the #time_reserved_until property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 62

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

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

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

  self.reserved_instance = attributes[:'reservedInstance'] if attributes[:'reservedInstance']

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

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

  self.time_reserved_until = attributes[:'timeReservedUntil'] if attributes[:'timeReservedUntil']

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

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

Instance Attribute Details

#committed_offset ⇒ Integer

The latest offset which has been committed for this partition.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 18

def committed_offset
  @committed_offset
end

#partition ⇒ String

The partition for which the reservation applies.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 14

def partition
  @partition
end

#reserved_instance ⇒ String

The consumer instance which currently has the partition reserved.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 22

def reserved_instance
  @reserved_instance
end

#time_reserved_until ⇒ DateTime

A timestamp when the current reservation expires.

Returns:

  • (DateTime) 


26
27
28
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 26

def time_reserved_until
  @time_reserved_until
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'partition': :'partition',
    'committed_offset': :'committedOffset',
    'reserved_instance': :'reservedInstance',
    'time_reserved_until': :'timeReservedUntil'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'partition': :'String',
    'committed_offset': :'Integer',
    'reserved_instance': :'String',
    'time_reserved_until': :'DateTime'
    # 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



96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 96

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

  self.class == other.class &&
    partition == other.partition &&
    committed_offset == other.committed_offset &&
    reserved_instance == other.reserved_instance &&
    time_reserved_until == other.time_reserved_until
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 129

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


109
110
111
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 118

def hash
  [partition, committed_offset, reserved_instance, time_reserved_until].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 162

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



156
157
158
 
# File 'lib/oci/streaming/models/partition_reservation.rb', line 156

def to_s
  to_hash.to_s
end