Class: OCI::Database::Models::KeyStoreSummary

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

Overview

Details of the Key Store.

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 = {}) ⇒ KeyStoreSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/database/models/key_store_summary.rb', line 141

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

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

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

  self.associated_long_term_backup_count = attributes[:'associatedLongTermBackupCount'] if attributes[:'associatedLongTermBackupCount']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_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_summary.rb', line 50

def associated_databases
  @associated_databases
end

#associated_long_term_backup_count ⇒ Integer

Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination.

Returns:

  • (Integer) 


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

def associated_long_term_backup_count
  @associated_long_term_backup_count
end

#associated_long_term_backups ⇒ Array<OCI::Database::Models::AssociatedLongTermBackup>

List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.

Returns:



54
55
56
 
# File 'lib/oci/database/models/key_store_summary.rb', line 54

def associated_long_term_backups
  @associated_long_term_backups
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database/models/key_store_summary.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>>) 


72
73
74
 
# File 'lib/oci/database/models/key_store_summary.rb', line 72

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_summary.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>) 


66
67
68
 
# File 'lib/oci/database/models/key_store_summary.rb', line 66

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_summary.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_summary.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_summary.rb', line 38

def lifecycle_state
  @lifecycle_state
end

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

System 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>>) 


78
79
80
 
# File 'lib/oci/database/models/key_store_summary.rb', line 78

def system_tags
  @system_tags
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_summary.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_summary.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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/database/models/key_store_summary.rb', line 81

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',
    'associated_long_term_backups': :'associatedLongTermBackups',
    'associated_long_term_backup_count': :'associatedLongTermBackupCount',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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>',
    'associated_long_term_backups': :'Array<OCI::Database::Models::AssociatedLongTermBackup>',
    'associated_long_term_backup_count': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



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_summary.rb', line 242

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 &&
    associated_long_term_backups == other.associated_long_term_backups &&
    associated_long_term_backup_count == other.associated_long_term_backup_count &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/database/models/key_store_summary.rb', line 284

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



273
274
275
 
# File 'lib/oci/database/models/key_store_summary.rb', line 273

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/database/models/key_store_summary.rb', line 317

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



311
312
313
 
# File 'lib/oci/database/models/key_store_summary.rb', line 311

def to_s
  to_hash.to_s
end