Class: OCI::Database::Models::KeyStore

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/key_store.rb

Overview

A key store to connect to an on-premise encryption key appliance like Oracle Key Vault.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_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 = {}) ⇒ KeyStore

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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/key_store.rb', line 118

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.type_details = attributes[:'typeDetails'] if attributes[:'typeDetails']

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

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

  self.associated_databases = attributes[:'associatedDatabases'] if attributes[:'associatedDatabases']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#associated_databases ⇒ Array<OCI::Database::Models::KeyStoreAssociatedDatabaseDetails>

List of databases associated with the key store.

Returns:



50
51
52
 
# File 'lib/oci/database/models/key_store.rb', line 50

def associated_databases
  @associated_databases
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>) 


64
65
66
 
# File 'lib/oci/database/models/key_store.rb', line 64

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the key store. The name does not need to be unique.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/database/models/key_store.rb', line 58

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the key store.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database/models/key_store.rb', line 42

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the key store.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database/models/key_store.rb', line 38

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time that the key store was created.

Returns:

  • (DateTime) 


34
35
36
 
# File 'lib/oci/database/models/key_store.rb', line 34

def time_created
  @time_created
end

#type_details ⇒ OCI::Database::Models::KeyStoreTypeDetails

This attribute is required.

Returns:



46
47
48
 
# File 'lib/oci/database/models/key_store.rb', line 46

def type_details
  @type_details
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/database/models/key_store.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'type_details': :'typeDetails',
    'associated_databases': :'associatedDatabases',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/database/models/key_store.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'type_details': :'OCI::Database::Models::KeyStoreTypeDetails',
    'associated_databases': :'Array<OCI::Database::Models::KeyStoreAssociatedDatabaseDetails>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/database/models/key_store.rb', line 198

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    type_details == other.type_details &&
    associated_databases == other.associated_databases &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/database/models/key_store.rb', line 237

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


217
218
219
 
# File 'lib/oci/database/models/key_store.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/oci/database/models/key_store.rb', line 226

def hash
  [id, compartment_id, display_name, time_created, lifecycle_state, lifecycle_details, type_details, associated_databases, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/database/models/key_store.rb', line 270

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



264
265
266
 
# File 'lib/oci/database/models/key_store.rb', line 264

def to_s
  to_hash.to_s
end