Class: OCI::GoldenGate::Models::MicrosoftFabricConnection

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/golden_gate/models/microsoft_fabric_connection.rb

Overview

Represents the metadata of a Microsoft Fabric Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM =
[
  TECHNOLOGY_TYPE_MICROSOFT_FABRIC_LAKEHOUSE = 'MICROSOFT_FABRIC_LAKEHOUSE'.freeze,
  TECHNOLOGY_TYPE_MICROSOFT_FABRIC_MIRROR = 'MICROSOFT_FABRIC_MIRROR'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM, Connection::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#cluster_placement_group_id, #compartment_id, #connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #locks, #nsg_ids, #routing_method, #security_attributes, #subnet_id, #subscription_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ MicrosoftFabricConnection

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 proprety

  • :display_name (String)

    The value to assign to the #display_name proprety

  • :description (String)

    The value to assign to the #description proprety

  • :compartment_id (String)

    The value to assign to the #compartment_id proprety

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

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

    The value to assign to the #system_tags proprety

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_details (String)

    The value to assign to the #lifecycle_details proprety

  • :time_created (DateTime)

    The value to assign to the #time_created proprety

  • :time_updated (DateTime)

    The value to assign to the #time_updated proprety

  • :locks (Array<OCI::GoldenGate::Models::ResourceLock>)

    The value to assign to the #locks proprety

  • :vault_id (String)

    The value to assign to the #vault_id proprety

  • :key_id (String)

    The value to assign to the #key_id proprety

  • :ingress_ips (Array<OCI::GoldenGate::Models::IngressIpDetails>)

    The value to assign to the #ingress_ips proprety

  • :nsg_ids (Array<String>)

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String)

    The value to assign to the #subnet_id proprety

  • :routing_method (String)

    The value to assign to the #routing_method proprety

  • :does_use_secret_ids (BOOLEAN)

    The value to assign to the #does_use_secret_ids proprety

  • :subscription_id (String)

    The value to assign to the #subscription_id proprety

  • :cluster_placement_group_id (String)

    The value to assign to the #cluster_placement_group_id proprety

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

    The value to assign to the #security_attributes proprety

  • :technology_type (String)

    The value to assign to the #technology_type property

  • :tenant_id (String)

    The value to assign to the #tenant_id property

  • :client_id (String)

    The value to assign to the #client_id property

  • :client_secret_secret_id (String)

    The value to assign to the #client_secret_secret_id property

  • :endpoint (String)

    The value to assign to the #endpoint property



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
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 153

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['connectionType'] = 'MICROSOFT_FABRIC'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType']

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

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

  self.tenant_id = attributes[:'tenantId'] if attributes[:'tenantId']

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

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

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

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

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

  self.client_secret_secret_id = attributes[:'clientSecretSecretId'] if attributes[:'clientSecretSecretId']

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

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

  self.endpoint = attributes[:'endpoint'] if attributes[:'endpoint']
end

Instance Attribute Details

#client_idString

[Required] Azure client ID of the application. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

Returns:

  • (String)


34
35
36
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 34

def client_id
  @client_id
end

#client_secret_secret_idString

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

Returns:

  • (String)


40
41
42
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 40

def client_secret_secret_id
  @client_secret_secret_id
end

#endpointString

Optional Microsoft Fabric service endpoint. Default value: onelake.dfs.fabric.microsoft.com

Returns:

  • (String)


46
47
48
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 46

def endpoint
  @endpoint
end

#technology_typeString

[Required] The Microsoft Fabric technology type.

Returns:

  • (String)


22
23
24
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 22

def technology_type
  @technology_type
end

#tenant_idString

[Required] Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

Returns:

  • (String)


28
29
30
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 28

def tenant_id
  @tenant_id
end

Class Method Details

.attribute_mapObject

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'locks': :'locks',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes',
    'technology_type': :'technologyType',
    'tenant_id': :'tenantId',
    'client_id': :'clientId',
    'client_secret_secret_id': :'clientSecretSecretId',
    'endpoint': :'endpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'technology_type': :'String',
    'tenant_id': :'String',
    'client_id': :'String',
    'client_secret_secret_id': :'String',
    'endpoint': :'String'
    # 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



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
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 210

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    locks == other.locks &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    subscription_id == other.subscription_id &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    security_attributes == other.security_attributes &&
    technology_type == other.technology_type &&
    tenant_id == other.tenant_id &&
    client_id == other.client_id &&
    client_secret_secret_id == other.client_secret_secret_id &&
    endpoint == other.endpoint
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 267

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


247
248
249
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 247

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



256
257
258
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 256

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, locks, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, does_use_secret_ids, subscription_id, cluster_placement_group_id, security_attributes, technology_type, tenant_id, client_id, client_secret_secret_id, endpoint].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 300

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



294
295
296
# File 'lib/oci/golden_gate/models/microsoft_fabric_connection.rb', line 294

def to_s
  to_hash.to_s
end