Class: OCI::Core::Models::MacsecProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/macsec_properties.rb

Overview

Properties used for MACsec (if capable).

Constant Summary collapse

STATE_ENUM = 
[
  STATE_ENABLED = 'ENABLED'.freeze,
  STATE_DISABLED = 'DISABLED'.freeze,
  STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ENCRYPTION_CIPHER_ENUM = 
[
  ENCRYPTION_CIPHER_AES128_GCM = 'AES128_GCM'.freeze,
  ENCRYPTION_CIPHER_AES128_GCM_XPN = 'AES128_GCM_XPN'.freeze,
  ENCRYPTION_CIPHER_AES256_GCM = 'AES256_GCM'.freeze,
  ENCRYPTION_CIPHER_AES256_GCM_XPN = 'AES256_GCM_XPN'.freeze,
  ENCRYPTION_CIPHER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MacsecProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/core/models/macsec_properties.rb', line 75

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

  self.primary_key = attributes[:'primaryKey'] if attributes[:'primaryKey']

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

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

  self.encryption_cipher = attributes[:'encryptionCipher'] if attributes[:'encryptionCipher']

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

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

  self.is_unprotected_traffic_allowed = attributes[:'isUnprotectedTrafficAllowed'] unless attributes[:'isUnprotectedTrafficAllowed'].nil?
  self.is_unprotected_traffic_allowed = false if is_unprotected_traffic_allowed.nil? && !attributes.key?(:'isUnprotectedTrafficAllowed') # rubocop:disable Style/StringLiterals

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

  self.is_unprotected_traffic_allowed = attributes[:'is_unprotected_traffic_allowed'] unless attributes[:'is_unprotected_traffic_allowed'].nil?
  self.is_unprotected_traffic_allowed = false if is_unprotected_traffic_allowed.nil? && !attributes.key?(:'isUnprotectedTrafficAllowed') && !attributes.key?(:'is_unprotected_traffic_allowed') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#encryption_cipher ⇒ String

Type of encryption cipher suite to use for the MACsec connection.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/core/models/macsec_properties.rb', line 35

def encryption_cipher
  @encryption_cipher
end

#is_unprotected_traffic_allowed ⇒ BOOLEAN

Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/oci/core/models/macsec_properties.rb', line 39

def is_unprotected_traffic_allowed
  @is_unprotected_traffic_allowed
end

#primary_key ⇒ OCI::Core::Models::MacsecKey

Returns:



31
32
33
 
# File 'lib/oci/core/models/macsec_properties.rb', line 31

def primary_key
  @primary_key
end

#state ⇒ String

[Required] Indicates whether or not MACsec is enabled.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/macsec_properties.rb', line 28

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/core/models/macsec_properties.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'state': :'state',
    'primary_key': :'primaryKey',
    'encryption_cipher': :'encryptionCipher',
    'is_unprotected_traffic_allowed': :'isUnprotectedTrafficAllowed'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/core/models/macsec_properties.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'state': :'String',
    'primary_key': :'OCI::Core::Models::MacsecKey',
    'encryption_cipher': :'String',
    'is_unprotected_traffic_allowed': :'BOOLEAN'
    # 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



137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/core/models/macsec_properties.rb', line 137

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

  self.class == other.class &&
    state == other.state &&
    primary_key == other.primary_key &&
    encryption_cipher == other.encryption_cipher &&
    is_unprotected_traffic_allowed == other.is_unprotected_traffic_allowed
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



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

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


150
151
152
 
# File 'lib/oci/core/models/macsec_properties.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/oci/core/models/macsec_properties.rb', line 159

def hash
  [state, primary_key, encryption_cipher, is_unprotected_traffic_allowed].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/core/models/macsec_properties.rb', line 203

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



197
198
199
 
# File 'lib/oci/core/models/macsec_properties.rb', line 197

def to_s
  to_hash.to_s
end