Class: OCI::Streaming::Models::Group

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

Overview

Represents the current state of a consumer group, including partition reservations and committed offsets.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Group

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/oci/streaming/models/group.rb', line 55

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

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

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

  self.group_name = attributes[:'groupName'] if attributes[:'groupName']

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

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

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

Instance Attribute Details

#group_nameString

[Required] The name of the consumer group.

Returns:

  • (String)


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

def group_name
  @group_name
end

#reservationsArray<OCI::Streaming::Models::PartitionReservation>

An array of the partition reservations of a group.



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

def reservations
  @reservations
end

#stream_idString

[Required] The streamId for which the group exists.

Returns:

  • (String)


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

def stream_id
  @stream_id
end

Class Method Details

.attribute_mapObject

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



25
26
27
28
29
30
31
32
33
# File 'lib/oci/streaming/models/group.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'stream_id': :'streamId',
    'group_name': :'groupName',
    'reservations': :'reservations'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



36
37
38
39
40
41
42
43
44
# File 'lib/oci/streaming/models/group.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'stream_id': :'String',
    'group_name': :'String',
    'reservations': :'Array<OCI::Streaming::Models::PartitionReservation>'
    # 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



83
84
85
86
87
88
89
90
# File 'lib/oci/streaming/models/group.rb', line 83

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

  self.class == other.class &&
    stream_id == other.stream_id &&
    group_name == other.group_name &&
    reservations == other.reservations
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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/oci/streaming/models/group.rb', line 115

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


95
96
97
# File 'lib/oci/streaming/models/group.rb', line 95

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



104
105
106
# File 'lib/oci/streaming/models/group.rb', line 104

def hash
  [stream_id, group_name, reservations].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



148
149
150
151
152
153
154
155
156
157
# File 'lib/oci/streaming/models/group.rb', line 148

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



142
143
144
# File 'lib/oci/streaming/models/group.rb', line 142

def to_s
  to_hash.to_s
end