Class: OCI::Streaming::Models::CreateStreamPoolDetails

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

Overview

Object used to create a stream pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateStreamPoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 88

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

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

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

  self.private_endpoint_details = attributes[:'privateEndpointDetails'] if attributes[:'privateEndpointDetails']

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

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

  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_idString

[Required] The OCID of the compartment that contains the stream.

Returns:

  • (String)


12
13
14
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 12

def compartment_id
  @compartment_id
end

#custom_encryption_key_detailsOCI::Streaming::Models::CustomEncryptionKeyDetails



25
26
27
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 25

def custom_encryption_key_details
  @custom_encryption_key_details
end

#defined_tagsHash<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: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


43
44
45
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 43

def defined_tags
  @defined_tags
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair that is applied 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>)


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

def freeform_tags
  @freeform_tags
end

#kafka_settingsOCI::Streaming::Models::KafkaSettings



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

def kafka_settings
  @kafka_settings
end

#nameString

[Required] The name of the stream pool. Avoid entering confidential information.

Example: MyStreamPool

Returns:

  • (String)


19
20
21
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 19

def name
  @name
end

#private_endpoint_detailsOCI::Streaming::Models::PrivateEndpointDetails



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

def private_endpoint_details
  @private_endpoint_details
end

Class Method Details

.attribute_mapObject

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



46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'name': :'name',
    'kafka_settings': :'kafkaSettings',
    'custom_encryption_key_details': :'customEncryptionKeyDetails',
    'private_endpoint_details': :'privateEndpointDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'name': :'String',
    'kafka_settings': :'OCI::Streaming::Models::KafkaSettings',
    'custom_encryption_key_details': :'OCI::Streaming::Models::CustomEncryptionKeyDetails',
    'private_endpoint_details': :'OCI::Streaming::Models::PrivateEndpointDetails',
    '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



140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 140

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    kafka_settings == other.kafka_settings &&
    custom_encryption_key_details == other.custom_encryption_key_details &&
    private_endpoint_details == other.private_endpoint_details &&
    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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 176

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


156
157
158
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 156

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



165
166
167
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 165

def hash
  [compartment_id, name, kafka_settings, custom_encryption_key_details, private_endpoint_details, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 209

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



203
204
205
# File 'lib/oci/streaming/models/create_stream_pool_details.rb', line 203

def to_s
  to_hash.to_s
end