Class: OCI::Dbmulticloud::Models::OracleDbAzureKey

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dbmulticloud/models/oracle_db_azure_key.rb

Overview

Oracle DB Azure Key resource object.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ OracleDbAzureKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :azure_key_id (String) —

    The value to assign to the #azure_key_id property

  • :oracle_db_azure_vault_id (String) —

    The value to assign to the #oracle_db_azure_vault_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_state_details (String) —

    The value to assign to the #lifecycle_state_details property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :key_properties (Object) —

    The value to assign to the #key_properties property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :last_modification (String) —

    The value to assign to the #last_modification property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 163

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

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

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

  self.oracle_db_azure_vault_id = attributes[:'oracleDbAzureVaultId'] if attributes[:'oracleDbAzureVaultId']

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

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

  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_state_details = attributes[:'lifecycleStateDetails'] if attributes[:'lifecycleStateDetails']

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

  self.key_properties = attributes[:'keyProperties'] if attributes[:'keyProperties']

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

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

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

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

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

  self.last_modification = attributes[:'lastModification'] if attributes[:'lastModification']

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

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

  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

#azure_key_id ⇒ String

The ID of the Azure Key resource.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 37

def azure_key_id
  @azure_key_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains Oracle DB Azure Vault Key resource.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 29

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.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


87
88
89
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 87

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Oracle DB Azure Vault Key resource name.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 33

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


79
80
81
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 79

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Oracle DB Azure Vault Key resource.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 25

def id
  @id
end

#key_properties ⇒ Object

Key properties

Returns:

  • (Object) 


57
58
59
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 57

def key_properties
  @key_properties
end

#last_modification ⇒ String

Description of the latest modification of the Oracle DB Azure Vault Key resource.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 71

def last_modification
  @last_modification
end

#lifecycle_state ⇒ String

The current lifecycle state of the Oracle DB Azure Vault Key resource.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 45

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_details ⇒ String

Description of the current lifecycle state in more detail.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 49

def lifecycle_state_details
  @lifecycle_state_details
end

#oracle_db_azure_vault_id ⇒ String

[Required] The OCID of the Oracle DB Azure Vault resource.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 41

def oracle_db_azure_vault_id
  @oracle_db_azure_vault_id
end

#resource_type ⇒ String

Key Resource type.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 53

def resource_type
  @resource_type
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


94
95
96
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 94

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Time when the Oracle DB Azure Vault Key resource was created in RFC 3339 timestamp format, e.g. '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 62

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Time when the Oracle DB Azure Vault Key resource was last modified, expressed in RFC 3339 timestamp format, e.g. '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 67

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 97

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'azure_key_id': :'azureKeyId',
    'oracle_db_azure_vault_id': :'oracleDbAzureVaultId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'resource_type': :'resourceType',
    'key_properties': :'keyProperties',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'last_modification': :'lastModification',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'azure_key_id': :'String',
    'oracle_db_azure_vault_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'resource_type': :'String',
    'key_properties': :'Object',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'last_modification': :'String',
    '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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 276

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    azure_key_id == other.azure_key_id &&
    oracle_db_azure_vault_id == other.oracle_db_azure_vault_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    resource_type == other.resource_type &&
    key_properties == other.key_properties &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    last_modification == other.last_modification &&
    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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 320

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


300
301
302
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 300

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 309

def hash
  [id, compartment_id, display_name, azure_key_id, oracle_db_azure_vault_id, lifecycle_state, lifecycle_state_details, resource_type, key_properties, time_created, time_updated, last_modification, 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



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 353

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



347
348
349
 
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_key.rb', line 347

def to_s
  to_hash.to_s
end