Class: OCI::Streaming::Models::CreateCursorDetails

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

Overview

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

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_AFTER_OFFSET = 'AFTER_OFFSET'.freeze,
  TYPE_AT_OFFSET = 'AT_OFFSET'.freeze,
  TYPE_AT_TIME = 'AT_TIME'.freeze,
  TYPE_LATEST = 'LATEST'.freeze,
  TYPE_TRIM_HORIZON = 'TRIM_HORIZON'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCursorDetails

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

  • :type (String)

    The value to assign to the #type property

  • :offset (Integer)

    The value to assign to the #offset property

  • :time (DateTime)

    The value to assign to the #time property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
# 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

Instance Attribute Details

#offsetInteger

The offset to consume from if the cursor type is AT_OFFSET or AFTER_OFFSET.

Returns:

  • (Integer)


35
36
37
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 35

def offset
  @offset
end

#partitionString

[Required] The partition to get messages from.

Returns:

  • (String)


20
21
22
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 20

def partition
  @partition
end

#timeDateTime

The time to consume from if the cursor type is AT_TIME, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime)


40
41
42
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 40

def time
  @time
end

#typeString

[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.

Returns:

  • (String)


31
32
33
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 31

def type
  @type
end

Class Method Details

.attribute_mapObject

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



43
44
45
46
47
48
49
50
51
52
# 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

.swagger_typesObject

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



106
107
108
109
110
111
112
113
114
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# 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) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


119
120
121
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 119

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



128
129
130
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 128

def hash
  [partition, type, offset, time].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



166
167
168
# File 'lib/oci/streaming/models/create_cursor_details.rb', line 166

def to_s
  to_hash.to_s
end