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

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

  • :sas_token (String)

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

  • :endpoint (String)

    The value to assign to the #endpoint property



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
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/update_azure_data_lake_storage_connection_details.rb', line 135

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

Instance Attribute Details

#account_keyString

Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

Returns:

  • (String)


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

def 
  @account_key
end

#account_nameString

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_typeString

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_idString

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)


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

def azure_tenant_id
  @azure_tenant_id
end

#client_idString

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)


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

def client_id
  @client_id
end

#client_secretString

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

Returns:

  • (String)


52
53
54
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 52

def client_secret
  @client_secret
end

#endpointString

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

Returns:

  • (String)


58
59
60
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 58

def endpoint
  @endpoint
end

#sas_tokenString

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

Returns:

  • (String)


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

def sas_token
  @sas_token
end

Class Method Details

.attribute_mapObject

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 61

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',
    'authentication_type': :'authenticationType',
    'account_name': :'accountName',
    'account_key': :'accountKey',
    'sas_token': :'sasToken',
    'azure_tenant_id': :'azureTenantId',
    'client_id': :'clientId',
    'client_secret': :'clientSecret',
    'endpoint': :'endpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 87

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',
    'authentication_type': :'String',
    'account_name': :'String',
    'account_key': :'String',
    'sas_token': :'String',
    'azure_tenant_id': :'String',
    'client_id': :'String',
    'client_secret': :'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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 197

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 &&
    authentication_type == other.authentication_type &&
     == other. &&
     == other. &&
    sas_token == other.sas_token &&
    azure_tenant_id == other.azure_tenant_id &&
    client_id == other.client_id &&
    client_secret == other.client_secret &&
    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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 244

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


224
225
226
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 224

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



233
234
235
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 233

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



277
278
279
280
281
282
283
284
285
286
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 277

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



271
272
273
# File 'lib/oci/golden_gate/models/update_azure_data_lake_storage_connection_details.rb', line 271

def to_s
  to_hash.to_s
end