Class: OCI::Dbmulticloud::Models::OracleDbGcpIdentityConnector

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

Overview

This resource is used to create and manage a GCP Identity Connector for Oracle Database running on Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). The Identity Connector enables secure communication between Oracle Cloud and Google Cloud services.

Constant Summary collapse

GCP_IDENTITY_CONNECTIVITY_STATUS_ENUM =
[
  GCP_IDENTITY_CONNECTIVITY_STATUS_CONNECTED = 'CONNECTED'.freeze,
  GCP_IDENTITY_CONNECTIVITY_STATUS_DISCONNECTED = 'DISCONNECTED'.freeze,
  GCP_IDENTITY_CONNECTIVITY_STATUS_PARTIALLY_CONNECTED = 'PARTIALLY_CONNECTED'.freeze,
  GCP_IDENTITY_CONNECTIVITY_STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  GCP_IDENTITY_CONNECTIVITY_STATUS_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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OracleDbGcpIdentityConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

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

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

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

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

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

  self.gcp_location = attributes[:'gcpLocation'] if attributes[:'gcpLocation']

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

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

  self.gcp_workload_identity_pool_id = attributes[:'gcpWorkloadIdentityPoolId'] if attributes[:'gcpWorkloadIdentityPoolId']

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

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

  self.gcp_workload_identity_provider_id = attributes[:'gcpWorkloadIdentityProviderId'] if attributes[:'gcpWorkloadIdentityProviderId']

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

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

  self.gcp_resource_service_agent_id = attributes[:'gcpResourceServiceAgentId'] if attributes[:'gcpResourceServiceAgentId']

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

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

  self.gcp_nodes = attributes[:'gcpNodes'] if attributes[:'gcpNodes']

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

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

  self.gcp_identity_connectivity_status = attributes[:'gcpIdentityConnectivityStatus'] if attributes[:'gcpIdentityConnectivityStatus']

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

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

  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

#compartment_idString

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

Returns:

  • (String)


42
43
44
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 42

def compartment_id
  @compartment_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>>)


112
113
114
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 112

def defined_tags
  @defined_tags
end

#display_nameString

Oracle DB GCP Identity Connector resource name.

Returns:

  • (String)


38
39
40
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 38

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


104
105
106
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 104

def freeform_tags
  @freeform_tags
end

#gcp_identity_connectivity_statusString

The current Connectivity status of GCP Identity Connector resource.

Returns:

  • (String)


78
79
80
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 78

def gcp_identity_connectivity_status
  @gcp_identity_connectivity_status
end

#gcp_locationString

[Required] GCP Location.

Returns:

  • (String)


58
59
60
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 58

def gcp_location
  @gcp_location
end

#gcp_nodesArray<OCI::Dbmulticloud::Models::GcpNodes>

List of All VMs where GCP Identity Connector is configured for this VMCluster.



74
75
76
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 74

def gcp_nodes
  @gcp_nodes
end

#gcp_resource_service_agent_idString

[Required] The ID of the GCP resource service agent.

Returns:

  • (String)


70
71
72
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 70

def gcp_resource_service_agent_id
  @gcp_resource_service_agent_id
end

#gcp_workload_identity_pool_idString

[Required] The ID of the cloud GCP Workload Identity Pool.

Returns:

  • (String)


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

def gcp_workload_identity_pool_id
  @gcp_workload_identity_pool_id
end

#gcp_workload_identity_provider_idString

[Required] The ID of the GCP Workload Identity Provider.

Returns:

  • (String)


66
67
68
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 66

def gcp_workload_identity_provider_id
  @gcp_workload_identity_provider_id
end

#idString

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

Returns:

  • (String)


34
35
36
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 34

def id
  @id
end

#issuer_urlString

[Required] OIDC token issuer Url.

Returns:

  • (String)


46
47
48
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 46

def issuer_url
  @issuer_url
end

#lifecycle_stateString

The current lifecycle state of the GCP Identity Connector resource.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_detailsString

Description of the current lifecycle state in more detail.

Returns:

  • (String)


86
87
88
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 86

def lifecycle_state_details
  @lifecycle_state_details
end

#project_idString

[Required] Project id of the customer project.

Returns:

  • (String)


50
51
52
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 50

def project_id
  @project_id
end

#resource_idString

[Required] The OCID of the GCP VM Cluster resource.

Returns:

  • (String)


54
55
56
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 54

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


119
120
121
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 119

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


96
97
98
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 96

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'issuer_url': :'issuerUrl',
    'project_id': :'projectId',
    'resource_id': :'resourceId',
    'gcp_location': :'gcpLocation',
    'gcp_workload_identity_pool_id': :'gcpWorkloadIdentityPoolId',
    'gcp_workload_identity_provider_id': :'gcpWorkloadIdentityProviderId',
    'gcp_resource_service_agent_id': :'gcpResourceServiceAgentId',
    'gcp_nodes': :'gcpNodes',
    'gcp_identity_connectivity_status': :'gcpIdentityConnectivityStatus',
    '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_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'issuer_url': :'String',
    'project_id': :'String',
    'resource_id': :'String',
    'gcp_location': :'String',
    'gcp_workload_identity_pool_id': :'String',
    'gcp_workload_identity_provider_id': :'String',
    'gcp_resource_service_agent_id': :'String',
    'gcp_nodes': :'Array<OCI::Dbmulticloud::Models::GcpNodes>',
    'gcp_identity_connectivity_status': :'String',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    issuer_url == other.issuer_url &&
    project_id == other.project_id &&
    resource_id == other.resource_id &&
    gcp_location == other.gcp_location &&
    gcp_workload_identity_pool_id == other.gcp_workload_identity_pool_id &&
    gcp_workload_identity_provider_id == other.gcp_workload_identity_provider_id &&
    gcp_resource_service_agent_id == other.gcp_resource_service_agent_id &&
    gcp_nodes == other.gcp_nodes &&
    gcp_identity_connectivity_status == other.gcp_identity_connectivity_status &&
    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



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

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


378
379
380
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 378

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



387
388
389
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 387

def hash
  [id, display_name, compartment_id, issuer_url, project_id, resource_id, gcp_location, gcp_workload_identity_pool_id, gcp_workload_identity_provider_id, gcp_resource_service_agent_id, gcp_nodes, gcp_identity_connectivity_status, lifecycle_state, lifecycle_state_details, time_created, time_updated, 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



431
432
433
434
435
436
437
438
439
440
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 431

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



425
426
427
# File 'lib/oci/dbmulticloud/models/oracle_db_gcp_identity_connector.rb', line 425

def to_s
  to_hash.to_s
end