Class: OCI::Streaming::Models::StreamPool

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

Overview

The details of a stream pool.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StreamPool

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 149

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_state_details = attributes[:'lifecycleStateDetails'] if attributes[:'lifecycleStateDetails']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.kafka_settings = attributes[:'kafkaSettings'] if attributes[:'kafkaSettings']

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

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

  self.custom_encryption_key = attributes[:'customEncryptionKey'] if attributes[:'customEncryptionKey']

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

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

  self.is_private = attributes[:'isPrivate'] unless attributes[:'isPrivate'].nil?

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

  self.is_private = attributes[:'is_private'] unless attributes[:'is_private'].nil?

  self.endpoint_fqdn = attributes[:'endpointFqdn'] if attributes[:'endpointFqdn']

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

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

  self.private_endpoint_settings = attributes[:'privateEndpointSettings'] if attributes[:'privateEndpointSettings']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment OCID that the pool belongs to.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 28

def compartment_id
  @compartment_id
end

#custom_encryption_key ⇒ OCI::Streaming::Models::CustomEncryptionKey

This attribute is required.

Returns:



55
56
57
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 55

def custom_encryption_key
  @custom_encryption_key
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: `{"CostCenter": "42"}'

Returns:

  • (Hash<String, Hash<String, Object>>) 


86
87
88
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 86

def defined_tags
  @defined_tags
end

#endpoint_fqdn ⇒ String

The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a OCI::Streaming::Models::Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 68

def endpoint_fqdn
  @endpoint_fqdn
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


79
80
81
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 79

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the stream pool.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 24

def id
  @id
end

#is_private ⇒ BOOLEAN

True if the stream pool is private, false otherwise. If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.

Returns:

  • (BOOLEAN) 


61
62
63
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 61

def is_private
  @is_private
end

#kafka_settings ⇒ OCI::Streaming::Models::KafkaSettings

This attribute is required.

Returns:



51
52
53
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 51

def kafka_settings
  @kafka_settings
end

#lifecycle_state ⇒ String

[Required] The current state of the stream pool.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 36

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_details ⇒ String

Any additional details about the current state of the stream.

Returns:

  • (String) 


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

def lifecycle_state_details
  @lifecycle_state_details
end

#name ⇒ String

[Required] The name of the stream pool.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 32

def name
  @name
end

#private_endpoint_settings ⇒ OCI::Streaming::Models::PrivateEndpointSettings

Returns:



71
72
73
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 71

def private_endpoint_settings
  @private_endpoint_settings
end

#time_created ⇒ DateTime

[Required] The date and time the stream pool was created, expressed in in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 47

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'time_created': :'timeCreated',
    'kafka_settings': :'kafkaSettings',
    'custom_encryption_key': :'customEncryptionKey',
    'is_private': :'isPrivate',
    'endpoint_fqdn': :'endpointFqdn',
    'private_endpoint_settings': :'privateEndpointSettings',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'time_created': :'DateTime',
    'kafka_settings': :'OCI::Streaming::Models::KafkaSettings',
    'custom_encryption_key': :'OCI::Streaming::Models::CustomEncryptionKey',
    'is_private': :'BOOLEAN',
    'endpoint_fqdn': :'String',
    'private_endpoint_settings': :'OCI::Streaming::Models::PrivateEndpointSettings',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 246

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    time_created == other.time_created &&
    kafka_settings == other.kafka_settings &&
    custom_encryption_key == other.custom_encryption_key &&
    is_private == other.is_private &&
    endpoint_fqdn == other.endpoint_fqdn &&
    private_endpoint_settings == other.private_endpoint_settings &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 288

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


268
269
270
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 268

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 277

def hash
  [id, compartment_id, name, lifecycle_state, lifecycle_state_details, time_created, kafka_settings, custom_encryption_key, is_private, endpoint_fqdn, private_endpoint_settings, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 321

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



315
316
317
 
# File 'lib/oci/streaming/models/stream_pool.rb', line 315

def to_s
  to_hash.to_s
end