Class: OCI::GoldenGate::Models::AzureDataLakeStorageConnectionSummary

Inherits:
ConnectionSummary
  • Object
show all
Defined in:
lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb

Overview

Summary of the Azure Data Lake Storage Connection.

Constant Summary

Constants inherited from ConnectionSummary

ConnectionSummary::CONNECTION_TYPE_ENUM, ConnectionSummary::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConnectionSummary

#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 ConnectionSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AzureDataLakeStorageConnectionSummary

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

  • :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

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

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

  • :authentication_type (String) —

    The value to assign to the #authentication_type property

  • :account_name (String) —

    The value to assign to the #account_name property

  • :azure_tenant_id (String) —

    The value to assign to the #azure_tenant_id property

  • :client_id (String) —

    The value to assign to the #client_id property

  • :endpoint (String) —

    The value to assign to the #endpoint property

  • :account_key_secret_id (String) —

    The value to assign to the #account_key_secret_id property

  • :sas_token_secret_id (String) —

    The value to assign to the #sas_token_secret_id property

  • :client_secret_secret_id (String) —

    The value to assign to the #client_secret_secret_id property

  • :azure_authority_host (String) —

    The value to assign to the #azure_authority_host property



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

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

  attributes['connectionType'] = 'AZURE_DATA_LAKE_STORAGE'

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

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

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

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

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

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

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

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

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

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

  self.sas_token_secret_id = attributes[:'sasTokenSecretId'] if attributes[:'sasTokenSecretId']

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

  self.sas_token_secret_id = attributes[:'sas_token_secret_id'] if attributes[:'sas_token_secret_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.azure_authority_host = attributes[:'azureAuthorityHost'] if attributes[:'azureAuthorityHost']

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

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

Instance Attribute Details

#account_key_secret_id ⇒ String

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 49

def 
  @account_key_secret_id
end

#account_name ⇒ String

[Required] Sets the Azure storage account name.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 25

def 
  @account_name
end

#authentication_type ⇒ String

[Required] Used authentication mechanism to access Azure Data Lake Storage.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 20

def authentication_type
  @authentication_type
end

#azure_authority_host ⇒ String

The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg: * Azure China: login.chinacloudapi.cn/ * Azure US Government: login.microsoftonline.us/

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 70

def azure_authority_host
  @azure_authority_host
end

#azure_tenant_id ⇒ String

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 31

def azure_tenant_id
  @azure_tenant_id
end

#client_id ⇒ String

Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 37

def client_id
  @client_id
end

#client_secret_secret_id ⇒ String

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

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 61

def client_secret_secret_id
  @client_secret_secret_id
end

#endpoint ⇒ String

Azure Storage service endpoint. e.g: test.blob.core.windows.net

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 43

def endpoint
  @endpoint
end

#sas_token_secret_id ⇒ String

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 55

def sas_token_secret_id
  @sas_token_secret_id
end

#technology_type ⇒ String

[Required] The Azure Data Lake Storage technology type.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 15

def technology_type
  @technology_type
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
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
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 73

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',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'locks': :'locks',
    'does_use_secret_ids': :'doesUseSecretIds',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes',
    'technology_type': :'technologyType',
    'authentication_type': :'authenticationType',
    'account_name': :'accountName',
    'azure_tenant_id': :'azureTenantId',
    'client_id': :'clientId',
    'endpoint': :'endpoint',
    'account_key_secret_id': :'accountKeySecretId',
    'sas_token_secret_id': :'sasTokenSecretId',
    'client_secret_secret_id': :'clientSecretSecretId',
    'azure_authority_host': :'azureAuthorityHost'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
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
147
148
149
150
151
152
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 114

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',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'does_use_secret_ids': :'BOOLEAN',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'technology_type': :'String',
    'authentication_type': :'String',
    'account_name': :'String',
    'azure_tenant_id': :'String',
    'client_id': :'String',
    'endpoint': :'String',
    'account_key_secret_id': :'String',
    'sas_token_secret_id': :'String',
    'client_secret_secret_id': :'String',
    'azure_authority_host': :'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



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

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 &&
    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 &&
    locks == other.locks &&
    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 &&
    authentication_type == other.authentication_type &&
     == other. &&
    azure_tenant_id == other.azure_tenant_id &&
    client_id == other.client_id &&
    endpoint == other.endpoint &&
     == other. &&
    sas_token_secret_id == other.sas_token_secret_id &&
    client_secret_secret_id == other.client_secret_secret_id &&
    azure_authority_host == other.azure_authority_host
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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 328

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


308
309
310
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 308

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



317
318
319
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 317

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 361

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



355
356
357
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection_summary.rb', line 355

def to_s
  to_hash.to_s
end