class OCI::Streaming::Models::PartitionReservation

Represents the state of a single partition reservation.

Attributes

committed_offset[RW]

The latest offset which has been committed for this partition. @return [Integer]

partition[RW]

The partition for which the reservation applies. @return [String]

reserved_instance[RW]

The consumer instance which currently has the partition reserved. @return [String]

time_reserved_until[RW]

A timestamp when the current reservation expires. @return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/streaming/models/partition_reservation.rb, line 28
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
new(attributes = {}) click to toggle source

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] :committed_offset The value to assign to the {#committed_offset} property @option attributes [String] :reserved_instance The value to assign to the {#reserved_instance} property @option attributes [DateTime] :time_reserved_until The value to assign to the {#time_reserved_until} property

# File lib/oci/streaming/models/partition_reservation.rb, line 61
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/streaming/models/partition_reservation.rb, line 40
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/streaming/models/partition_reservation.rb, line 95
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) click to toggle source

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/partition_reservation.rb, line 128
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/streaming/models/partition_reservation.rb, line 108
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/streaming/models/partition_reservation.rb, line 117
def hash
  [partition, committed_offset, reserved_instance, time_reserved_until].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/streaming/models/partition_reservation.rb, line 161
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/streaming/models/partition_reservation.rb, line 155
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/partition_reservation.rb, line 178
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