Class: OCI::GoldenGate::Models::AzureDataLakeStorageConnection

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

Overview

Represents the metadata of a Azure Data Lake Storage Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUTHENTICATION_TYPE_ENUM = 
[
  AUTHENTICATION_TYPE_SHARED_KEY = 'SHARED_KEY'.freeze,
  AUTHENTICATION_TYPE_SHARED_ACCESS_SIGNATURE = 'SHARED_ACCESS_SIGNATURE'.freeze,
  AUTHENTICATION_TYPE_AZURE_ACTIVE_DIRECTORY = 'AZURE_ACTIVE_DIRECTORY'.freeze,
  AUTHENTICATION_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

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #nsg_ids, #routing_method, #subnet_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 = {}) ⇒ AzureDataLakeStorageConnection

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

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



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
189
190
191
192
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 151

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']
end

Instance Attribute Details

#account_name ⇒ String

[Required] Sets the Azure storage account name.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 38

def 
  @account_name
end

#authentication_type ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 33

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) 


44
45
46
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 44

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) 


50
51
52
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 50

def client_id
  @client_id
end

#endpoint ⇒ String

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

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 56

def endpoint
  @endpoint
end

#technology_type ⇒ String

[Required] The Azure Data Lake Storage technology type.

Returns:

  • (String) 


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

def technology_type
  @technology_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'technology_type': :'technologyType',
    'authentication_type': :'authenticationType',
    'account_name': :'accountName',
    'azure_tenant_id': :'azureTenantId',
    'client_id': :'clientId',
    'endpoint': :'endpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
119
120
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 91

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',
    'technology_type': :'String',
    'authentication_type': :'String',
    'account_name': :'String',
    'azure_tenant_id': :'String',
    'client_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



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

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 280

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


260
261
262
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 260

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 269

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, technology_type, authentication_type, , azure_tenant_id, client_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



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 313

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



307
308
309
 
# File 'lib/oci/golden_gate/models/azure_data_lake_storage_connection.rb', line 307

def to_s
  to_hash.to_s
end