Class: OCI::GloballyDistributedDatabase::Models::DedicatedShardOrCatalogEncryptionKeyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb

Overview

Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedShardOrCatalogEncryptionKeyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vault_id (String) —

    The value to assign to the #vault_id property

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :kms_key_version_id (String) —

    The value to assign to the #kms_key_version_id property



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 68

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

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

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

  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.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_id ⇒ String

[Required] The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 29

def kms_key_id
  @kms_key_id
end

#kms_key_version_id ⇒ String

The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 35

def kms_key_version_id
  @kms_key_version_id
end

#vault_id ⇒ String

[Required] The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 23

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vault_id': :'vaultId',
    'kms_key_id': :'kmsKeyId',
    'kms_key_version_id': :'kmsKeyVersionId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 49

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



100
101
102
103
104
105
106
107
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 100

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

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 132

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


112
113
114
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 121

def hash
  [vault_id, kms_key_id, 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



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 165

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



159
160
161
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_or_catalog_encryption_key_details.rb', line 159

def to_s
  to_hash.to_s
end