Class: OCI::Streaming::Models::UpdateStreamPoolDetails

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

Overview

Object used to update the stream pool's details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateStreamPoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



87
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
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 87

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

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

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

  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

#custom_encryption_key_details ⇒ OCI::Streaming::Models::CustomEncryptionKeyDetails

Returns:



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

def custom_encryption_key_details
  @custom_encryption_key_details
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: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


45
46
47
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 45

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<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>) 


30
31
32
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 30

def freeform_tags
  @freeform_tags
end

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

Returns:



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

def kafka_settings
  @kafka_settings
end

#name ⇒ String

The name of the stream pool. Avoid entering confidential information.

Example: MyStreamPool

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 16

def name
  @name
end

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

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

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


38
39
40
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 38

def security_attributes
  @security_attributes
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 133

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

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 168

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


148
149
150
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 157

def hash
  [name, kafka_settings, custom_encryption_key_details, freeform_tags, security_attributes, 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



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 201

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



195
196
197
 
# File 'lib/oci/streaming/models/update_stream_pool_details.rb', line 195

def to_s
  to_hash.to_s
end