Class: OCI::Dbmulticloud::Models::OracleDbAwsKey

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

Overview

Oracle DB AWS 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 = {}) ⇒ OracleDbAwsKey

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

  • :oracle_db_connector_id (String) —

    The value to assign to the #oracle_db_connector_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :aws_key_arn (String) —

    The value to assign to the #aws_key_arn property

  • :aws_account_id (String) —

    The value to assign to the #aws_account_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :type (String) —

    The value to assign to the #type property

  • :is_aws_key_enabled (BOOLEAN) —

    The value to assign to the #is_aws_key_enabled property

  • :location (String) —

    The value to assign to the #location property

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

    The value to assign to the #properties property

  • :replication_metadata (OCI::Dbmulticloud::Models::ReplicationMetadata) —

    The value to assign to the #replication_metadata 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

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated 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



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 183

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

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

  self.oracle_db_connector_id = attributes[:'oracle_db_connector_id'] if attributes[:'oracle_db_connector_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.aws_key_arn = attributes[:'awsKeyArn'] if attributes[:'awsKeyArn']

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

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

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

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

  self. = attributes[:'aws_account_id'] if attributes[:'aws_account_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.type = attributes[:'type'] if attributes[:'type']

  self.is_aws_key_enabled = attributes[:'isAwsKeyEnabled'] unless attributes[:'isAwsKeyEnabled'].nil?

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

  self.is_aws_key_enabled = attributes[:'is_aws_key_enabled'] unless attributes[:'is_aws_key_enabled'].nil?

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

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

  self.replication_metadata = attributes[:'replicationMetadata'] if attributes[:'replicationMetadata']

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

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

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

#aws_account_id ⇒ String

AWS Account ID.

Returns:

  • (String) 


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

def 
  @aws_account_id
end

#aws_key_arn ⇒ String

Amazon resource name of AWS Key.

Returns:

  • (String) 


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

def aws_key_arn
  @aws_key_arn
end

#compartment_id ⇒ String

[Required] The Compartment OCID that contains this Oracle DB AWS Key resource.

Returns:

  • (String) 


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

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


98
99
100
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 98

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Oracle DB AWS Key Ring resource name.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_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>) 


90
91
92
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the DB AWS Key Ring resource.

Returns:

  • (String) 


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

def id
  @id
end

#is_aws_key_enabled ⇒ BOOLEAN

The Oracle AWS Key resource is enabled or disabled at AWS.

Returns:

  • (BOOLEAN) 


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

def is_aws_key_enabled
  @is_aws_key_enabled
end

#lifecycle_state ⇒ String

The lifecycle state of the Oracle DB AWS Key resource.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 68

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_details ⇒ String

Description of the current lifecycle state in more detail.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 72

def lifecycle_state_details
  @lifecycle_state_details
end

#location ⇒ String

AWS Key resource location.

Returns:

  • (String) 


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

def location
  @location
end

#oracle_db_connector_id ⇒ String

The OCID of the Oracle DB Connector resource.

Returns:

  • (String) 


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

def oracle_db_connector_id
  @oracle_db_connector_id
end

#properties ⇒ Hash<String, String>

AWS Key resource's properties.

Returns:

  • (Hash<String, String>) 


61
62
63
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 61

def properties
  @properties
end

#replication_metadata ⇒ OCI::Dbmulticloud::Models::ReplicationMetadata

Returns:



64
65
66
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 64

def replication_metadata
  @replication_metadata
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>>) 


105
106
107
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 105

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 77

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 82

def time_updated
  @time_updated
end

#type ⇒ String

Key resource type.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 108

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'oracle_db_connector_id': :'oracleDbConnectorId',
    'display_name': :'displayName',
    'aws_key_arn': :'awsKeyArn',
    'aws_account_id': :'awsAccountId',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'is_aws_key_enabled': :'isAwsKeyEnabled',
    'location': :'location',
    'properties': :'properties',
    'replication_metadata': :'replicationMetadata',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 134

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'oracle_db_connector_id': :'String',
    'display_name': :'String',
    'aws_key_arn': :'String',
    'aws_account_id': :'String',
    'compartment_id': :'String',
    'type': :'String',
    'is_aws_key_enabled': :'BOOLEAN',
    'location': :'String',
    'properties': :'Hash<String, String>',
    'replication_metadata': :'OCI::Dbmulticloud::Models::ReplicationMetadata',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 302

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

  self.class == other.class &&
    id == other.id &&
    oracle_db_connector_id == other.oracle_db_connector_id &&
    display_name == other.display_name &&
    aws_key_arn == other.aws_key_arn &&
     == other. &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    is_aws_key_enabled == other.is_aws_key_enabled &&
    location == other.location &&
    properties == other.properties &&
    replication_metadata == other.replication_metadata &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 349

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


329
330
331
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 329

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 338

def hash
  [id, oracle_db_connector_id, display_name, aws_key_arn, , compartment_id, type, is_aws_key_enabled, location, properties, replication_metadata, lifecycle_state, lifecycle_state_details, time_created, time_updated, 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



382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 382

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



376
377
378
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_key.rb', line 376

def to_s
  to_hash.to_s
end