Class: OCI::Streaming::Models::CustomEncryptionKey

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

Overview

Custom Encryption Key which will be used for encryption by all the streams in the pool.

Constant Summary collapse

KEY_STATE_ENUM = 
[
  KEY_STATE_ACTIVE = 'ACTIVE'.freeze,
  KEY_STATE_CREATING = 'CREATING'.freeze,
  KEY_STATE_DELETING = 'DELETING'.freeze,
  KEY_STATE_NONE = 'NONE'.freeze,
  KEY_STATE_FAILED = 'FAILED'.freeze,
  KEY_STATE_UPDATING = 'UPDATING'.freeze,
  KEY_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 = {}) ⇒ CustomEncryptionKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :key_state (String) —

    The value to assign to the #key_state property



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

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

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

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

  self.key_state = attributes[:'keyState'] if attributes[:'keyState']

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

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

Instance Attribute Details

#key_state ⇒ String

Life cycle State of the custom key

Returns:

  • (String) 


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

def key_state
  @key_state
end

#kms_key_id ⇒ String

Custom Encryption Key (Master Key) ocid.

Returns:

  • (String) 


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

def kms_key_id
  @kms_key_id
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kms_key_id': :'kmsKeyId',
    'key_state': :'keyState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kms_key_id': :'String',
    'key_state': :'String'
    # 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



97
98
99
100
101
102
103
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 97

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

  self.class == other.class &&
    kms_key_id == other.kms_key_id &&
    key_state == other.key_state
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 128

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


108
109
110
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 117

def hash
  [kms_key_id, key_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 161

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



155
156
157
 
# File 'lib/oci/streaming/models/custom_encryption_key.rb', line 155

def to_s
  to_hash.to_s
end