class OCI::Streaming::Models::CreateCursorDetails

Object used to create a cursor to consume messages in a stream.

Constants

TYPE_ENUM

Attributes

offset[RW]

The offset to consume from if the cursor type is `AT_OFFSET` or `AFTER_OFFSET`. @return [Integer]

partition[RW]

[Required] The partition to get messages from. @return [String]

time[RW]

The time to consume from if the cursor type is `AT_TIME`, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.

@return [DateTime]

type[R]

[Required] The type of cursor, which determines the starting point from which the stream will be consumed:

  • `AFTER_OFFSET:` The partition position immediately following the offset you specify. (Offsets are assigned when you successfully append a message to a partition in a stream.)

  • `AT_OFFSET:` The exact partition position indicated by the offset you specify.

  • `AT_TIME:` A specific point in time.

  • `LATEST:` The most recent message in the partition that was added after the cursor was created.

  • `TRIM_HORIZON:` The oldest message in the partition that is within the retention period window.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/streaming/models/create_cursor_details.rb, line 43
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'partition': :'partition',
    'type': :'type',
    'offset': :'offset',
    'time': :'time'
    # 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 [String] :type The value to assign to the {#type} property @option attributes [Integer] :offset The value to assign to the {#offset} property @option attributes [DateTime] :time The value to assign to the {#time} property

# File lib/oci/streaming/models/create_cursor_details.rb, line 76
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.type = attributes[:'type'] if attributes[:'type']

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

  self.time = attributes[:'time'] if attributes[:'time']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/streaming/models/create_cursor_details.rb, line 55
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'partition': :'String',
    'type': :'String',
    'offset': :'Integer',
    'time': :'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/create_cursor_details.rb, line 106
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    partition == other.partition &&
    type == other.type &&
    offset == other.offset &&
    time == other.time
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/create_cursor_details.rb, line 139
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/create_cursor_details.rb, line 119
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/create_cursor_details.rb, line 128
def hash
  [partition, type, offset, time].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/create_cursor_details.rb, line 172
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/create_cursor_details.rb, line 166
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/oci/streaming/models/create_cursor_details.rb, line 95
def type=(type)
  raise "Invalid value for 'type': this must be one of the values in TYPE_ENUM." if type && !TYPE_ENUM.include?(type)

  @type = type
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/create_cursor_details.rb, line 189
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