Class: OCI::Database::Models::OciProviderSetKeyVersionDetails

Inherits:
SetKeyVersionDetails show all
Defined in:
lib/oci/database/models/oci_provider_set_key_version_details.rb

Overview

Used for setting KMS key versions

Constant Summary

Constants inherited from SetKeyVersionDetails

SetKeyVersionDetails::PROVIDER_ENUM

Instance Attribute Summary collapse

Attributes inherited from SetKeyVersionDetails

#provider

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SetKeyVersionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OciProviderSetKeyVersionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 44

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['provider'] = 'OCI'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.kms_key_version_id = attributes[:'kmsKeyVersionId'] if attributes[:'kmsKeyVersionId']

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

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

Instance Attribute Details

#kms_key_version_id ⇒ String

[Required] The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 15

def kms_key_version_id
  @kms_key_version_id
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 18

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'provider': :'provider',
    'kms_key_version_id': :'kmsKeyVersionId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
35
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 28

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



68
69
70
71
72
73
74
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 68

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

  self.class == other.class &&
    provider == other.provider &&
    kms_key_version_id == other.kms_key_version_id
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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 99

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


79
80
81
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 79

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



88
89
90
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 88

def hash
  [provider, kms_key_version_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 132

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



126
127
128
 
# File 'lib/oci/database/models/oci_provider_set_key_version_details.rb', line 126

def to_s
  to_hash.to_s
end