Class: OCI::Database::Models::OkvKeyDetails

Inherits:
AutonomousDatabaseEncryptionKeyDetails show all
Defined in:
lib/oci/database/models/okv_key_details.rb

Overview

Details for OKV encryption key.

Constant Summary

Constants inherited from AutonomousDatabaseEncryptionKeyDetails

AutonomousDatabaseEncryptionKeyDetails::PROVIDER_ENUM

Instance Attribute Summary collapse

Attributes inherited from AutonomousDatabaseEncryptionKeyDetails

#provider

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AutonomousDatabaseEncryptionKeyDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OkvKeyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :okv_uri (String)

    The value to assign to the #okv_uri property

  • :okv_kms_key (String)

    The value to assign to the #okv_kms_key property

  • :directory_name (String)

    The value to assign to the #directory_name property

  • :certificate_directory_name (String)

    The value to assign to the #certificate_directory_name property

  • :certificate_id (String)

    The value to assign to the #certificate_id property



71
72
73
74
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
103
104
105
106
107
108
109
110
# File 'lib/oci/database/models/okv_key_details.rb', line 71

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

  attributes['provider'] = 'OKV'

  super(attributes)

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

  self.okv_uri = attributes[:'okvUri'] if attributes[:'okvUri']

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

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

  self.okv_kms_key = attributes[:'okvKmsKey'] if attributes[:'okvKmsKey']

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

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

  self.directory_name = attributes[:'directoryName'] if attributes[:'directoryName']

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

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

  self.certificate_directory_name = attributes[:'certificateDirectoryName'] if attributes[:'certificateDirectoryName']

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

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

  self.certificate_id = attributes[:'certificateId'] if attributes[:'certificateId']

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

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

Instance Attribute Details

#certificate_directory_nameString

[Required] OKV certificate directory name

Returns:

  • (String)


26
27
28
# File 'lib/oci/database/models/okv_key_details.rb', line 26

def certificate_directory_name
  @certificate_directory_name
end

#certificate_idString

OKV certificate id

Returns:

  • (String)


30
31
32
# File 'lib/oci/database/models/okv_key_details.rb', line 30

def certificate_id
  @certificate_id
end

#directory_nameString

[Required] OKV wallet directory name

Returns:

  • (String)


22
23
24
# File 'lib/oci/database/models/okv_key_details.rb', line 22

def directory_name
  @directory_name
end

#okv_kms_keyString

[Required] UUID of OKV KMS Key

Returns:

  • (String)


18
19
20
# File 'lib/oci/database/models/okv_key_details.rb', line 18

def okv_kms_key
  @okv_kms_key
end

#okv_uriString

[Required] URI of OKV server

Returns:

  • (String)


14
15
16
# File 'lib/oci/database/models/okv_key_details.rb', line 14

def okv_uri
  @okv_uri
end

Class Method Details

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/oci/database/models/okv_key_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'provider': :'provider',
    'okv_uri': :'okvUri',
    'okv_kms_key': :'okvKmsKey',
    'directory_name': :'directoryName',
    'certificate_directory_name': :'certificateDirectoryName',
    'certificate_id': :'certificateId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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



119
120
121
122
123
124
125
126
127
128
129
# File 'lib/oci/database/models/okv_key_details.rb', line 119

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

  self.class == other.class &&
    provider == other.provider &&
    okv_uri == other.okv_uri &&
    okv_kms_key == other.okv_kms_key &&
    directory_name == other.directory_name &&
    certificate_directory_name == other.certificate_directory_name &&
    certificate_id == other.certificate_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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/oci/database/models/okv_key_details.rb', line 154

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


134
135
136
# File 'lib/oci/database/models/okv_key_details.rb', line 134

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



143
144
145
# File 'lib/oci/database/models/okv_key_details.rb', line 143

def hash
  [provider, okv_uri, okv_kms_key, directory_name, certificate_directory_name, certificate_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
# File 'lib/oci/database/models/okv_key_details.rb', line 187

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



181
182
183
# File 'lib/oci/database/models/okv_key_details.rb', line 181

def to_s
  to_hash.to_s
end