Class: OCI::GoldenGate::Models::UpdateAzureDataLakeStorageConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb

Overview

The information to update a Azure Data Lake Storage Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #key_id, #nsg_ids, #routing_method, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateAzureDataLakeStorageConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

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

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

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

  • :authentication_type (String) —

    The value to assign to the #authentication_type property

  • :account_name (String) —

    The value to assign to the #account_name property

  • :account_key (String) —

    The value to assign to the #account_key property

  • :account_key_secret_id (String) —

    The value to assign to the #account_key_secret_id property

  • :sas_token (String) —

    The value to assign to the #sas_token property

  • :sas_token_secret_id (String) —

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

  • :client_secret (String) —

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 168

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

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

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

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

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

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

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

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

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

  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

#account_key ⇒ String

Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


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

def 
  @account_key
end

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


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

def 
  @account_key_secret_id
end

#account_name ⇒ String

Sets the Azure storage account name.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 21

def 
  @account_name
end

#authentication_type ⇒ String

Used authentication mechanism to access Azure Data Lake Storage.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 16

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


54
55
56
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 54

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) 


60
61
62
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 60

def client_id
  @client_id
end

#client_secret ⇒ String

Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 67

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


73
74
75
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 73

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) 


79
80
81
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 79

def endpoint
  @endpoint
end

#sas_token ⇒ String

Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 42

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


48
49
50
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 48

def sas_token_secret_id
  @sas_token_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'authentication_type': :'authenticationType',
    'account_name': :'accountName',
    'account_key': :'accountKey',
    'account_key_secret_id': :'accountKeySecretId',
    'sas_token': :'sasToken',
    'sas_token_secret_id': :'sasTokenSecretId',
    'azure_tenant_id': :'azureTenantId',
    'client_id': :'clientId',
    'client_secret': :'clientSecret',
    'client_secret_secret_id': :'clientSecretSecretId',
    'endpoint': :'endpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'authentication_type': :'String',
    'account_name': :'String',
    'account_key': :'String',
    'account_key_secret_id': :'String',
    'sas_token': :'String',
    'sas_token_secret_id': :'String',
    'azure_tenant_id': :'String',
    'client_id': :'String',
    'client_secret': :'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



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

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    authentication_type == other.authentication_type &&
     == other. &&
     == other. &&
     == other. &&
    sas_token == other.sas_token &&
    sas_token_secret_id == other.sas_token_secret_id &&
    azure_tenant_id == other.azure_tenant_id &&
    client_id == other.client_id &&
    client_secret == other.client_secret &&
    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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 299

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


279
280
281
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 279

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 288

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, authentication_type, , , , sas_token, sas_token_secret_id, azure_tenant_id, client_id, client_secret, client_secret_secret_id, endpoint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 332

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



326
327
328
 
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 326

def to_s
  to_hash.to_s
end