Class: OCI::Dbmulticloud::Models::OracleDbAzureConnector

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

Overview

Oracle DB Azure Connector resource.

Constant Summary collapse

AZURE_IDENTITY_MECHANISM_ENUM =
[
  AZURE_IDENTITY_MECHANISM_ARC_AGENT = 'ARC_AGENT'.freeze,
  AZURE_IDENTITY_MECHANISM_SERVICE_PRINCIPAL = 'SERVICE_PRINCIPAL'.freeze,
  AZURE_IDENTITY_MECHANISM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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
AZURE_IDENTITY_CONNECTIVITY_STATUS_ENUM =
[
  AZURE_IDENTITY_CONNECTIVITY_STATUS_CONNECTED = 'CONNECTED'.freeze,
  AZURE_IDENTITY_CONNECTIVITY_STATUS_DISCONNECTED = 'DISCONNECTED'.freeze,
  AZURE_IDENTITY_CONNECTIVITY_STATUS_PARTIALLY_CONNECTED = 'PARTIALLY_CONNECTED'.freeze,
  AZURE_IDENTITY_CONNECTIVITY_STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  AZURE_IDENTITY_CONNECTIVITY_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OracleDbAzureConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 219

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

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

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

  self.db_cluster_resource_id = attributes[:'dbClusterResourceId'] if attributes[:'dbClusterResourceId']

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

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

  self.azure_tenant_id = attributes[:'azureTenantId'] if attributes[:'azureTenantId']

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

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

  self.azure_subscription_id = attributes[:'azureSubscriptionId'] if attributes[:'azureSubscriptionId']

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

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

  self.azure_resource_group = attributes[:'azureResourceGroup'] if attributes[:'azureResourceGroup']

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

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

  self.access_token = attributes[:'accessToken'] if attributes[:'accessToken']

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

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

  self.private_endpoint_ip_address = attributes[:'privateEndpointIpAddress'] if attributes[:'privateEndpointIpAddress']

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

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

  self.private_endpoint_dns_alias = attributes[:'privateEndpointDnsAlias'] if attributes[:'privateEndpointDnsAlias']

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

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

  self.azure_identity_mechanism = attributes[:'azureIdentityMechanism'] if attributes[:'azureIdentityMechanism']

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

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

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

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

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

  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

#access_tokenString

Azure bearer access token.

Returns:

  • (String)


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

def access_token
  @access_token
end

#arc_agent_nodesArray<OCI::Dbmulticloud::Models::ArcAgentNodes>

List of all VMs where Arc Agent is installed under Cloud VM Cluster.



51
52
53
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 51

def arc_agent_nodes
  @arc_agent_nodes
end

#azure_identity_connectivity_statusString

The current Connectivity status of Azure Identity Connector resource.

Returns:

  • (String)


95
96
97
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 95

def azure_identity_connectivity_status
  @azure_identity_connectivity_status
end

#azure_identity_mechanismString

Azure Identity mechanism.

Returns:

  • (String)


83
84
85
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 83

def azure_identity_mechanism
  @azure_identity_mechanism
end

#azure_resource_groupString

[Required] Azure Resource group name.

Returns:

  • (String)


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

def azure_resource_group
  @azure_resource_group
end

#azure_subscription_idString

[Required] Azure Subscription ID.

Returns:

  • (String)


63
64
65
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 63

def azure_subscription_id
  @azure_subscription_id
end

#azure_tenant_idString

[Required] Azure Tenant ID.

Returns:

  • (String)


59
60
61
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 59

def azure_tenant_id
  @azure_tenant_id
end

#compartment_idString

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

Returns:

  • (String)


47
48
49
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 47

def compartment_id
  @compartment_id
end

#db_cluster_resource_idString

[Required] The OCID of the Oracle DB Cloud VM Cluster resource where this Azure Arc Agent identity to configure.

Returns:

  • (String)


55
56
57
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 55

def db_cluster_resource_id
  @db_cluster_resource_id
end

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


125
126
127
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 125

def defined_tags
  @defined_tags
end

#display_nameString

Oracle DB Azure Connector resource name.

Returns:

  • (String)


43
44
45
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 43

def display_name
  @display_name
end

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


117
118
119
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 117

def freeform_tags
  @freeform_tags
end

#idString

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

Returns:

  • (String)


39
40
41
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 39

def id
  @id
end

#last_modificationString

Description of the latest modification of the Oracle DB Azure Connector resource.

Returns:

  • (String)


109
110
111
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 109

def last_modification
  @last_modification
end

#lifecycle_stateString

The current lifecycle state of the Azure Arc Agent resource.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_detailsString

Description of the current lifecycle state in more detail.

Returns:

  • (String)


91
92
93
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 91

def lifecycle_state_details
  @lifecycle_state_details
end

#private_endpoint_dns_aliasString

Private endpoint's DNS alias.

Returns:

  • (String)


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

def private_endpoint_dns_alias
  @private_endpoint_dns_alias
end

#private_endpoint_ip_addressString

Private endpoint IP.

Returns:

  • (String)


75
76
77
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 75

def private_endpoint_ip_address
  @private_endpoint_ip_address
end

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


132
133
134
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 132

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


100
101
102
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 100

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 135

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'arc_agent_nodes': :'arcAgentNodes',
    'db_cluster_resource_id': :'dbClusterResourceId',
    'azure_tenant_id': :'azureTenantId',
    'azure_subscription_id': :'azureSubscriptionId',
    'azure_resource_group': :'azureResourceGroup',
    'access_token': :'accessToken',
    'private_endpoint_ip_address': :'privateEndpointIpAddress',
    'private_endpoint_dns_alias': :'privateEndpointDnsAlias',
    'azure_identity_mechanism': :'azureIdentityMechanism',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'azure_identity_connectivity_status': :'azureIdentityConnectivityStatus',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'last_modification': :'lastModification',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 164

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'arc_agent_nodes': :'Array<OCI::Dbmulticloud::Models::ArcAgentNodes>',
    'db_cluster_resource_id': :'String',
    'azure_tenant_id': :'String',
    'azure_subscription_id': :'String',
    'azure_resource_group': :'String',
    'access_token': :'String',
    'private_endpoint_ip_address': :'String',
    'private_endpoint_dns_alias': :'String',
    'azure_identity_mechanism': :'String',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'azure_identity_connectivity_status': :'String',
    '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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 394

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    arc_agent_nodes == other.arc_agent_nodes &&
    db_cluster_resource_id == other.db_cluster_resource_id &&
    azure_tenant_id == other.azure_tenant_id &&
    azure_subscription_id == other.azure_subscription_id &&
    azure_resource_group == other.azure_resource_group &&
    access_token == other.access_token &&
    private_endpoint_ip_address == other.private_endpoint_ip_address &&
    private_endpoint_dns_alias == other.private_endpoint_dns_alias &&
    azure_identity_mechanism == other.azure_identity_mechanism &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    azure_identity_connectivity_status == other.azure_identity_connectivity_status &&
    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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 444

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


424
425
426
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 424

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



433
434
435
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 433

def hash
  [id, display_name, compartment_id, arc_agent_nodes, db_cluster_resource_id, azure_tenant_id, azure_subscription_id, azure_resource_group, access_token, private_endpoint_ip_address, private_endpoint_dns_alias, azure_identity_mechanism, lifecycle_state, lifecycle_state_details, azure_identity_connectivity_status, time_created, time_updated, last_modification, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



477
478
479
480
481
482
483
484
485
486
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 477

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



471
472
473
# File 'lib/oci/dbmulticloud/models/oracle_db_azure_connector.rb', line 471

def to_s
  to_hash.to_s
end