Class: OCI::DataIntegration::Models::ConnectionFromRestBasicAuth

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/data_integration/models/connection_from_rest_basic_auth.rb

Overview

The connection details for a basic auth rest connection.

Constant Summary

Constants inherited from Connection

OCI::DataIntegration::Models::Connection::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#connection_properties, #description, #identifier, #is_default, #key, #key_map, #metadata, #model_type, #model_version, #name, #object_status, #object_version, #parent_ref, #primary_schema

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ConnectionFromRestBasicAuth

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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/data_integration/models/connection_from_rest_basic_auth.rb', line 95

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

  attributes['modelType'] = 'REST_BASIC_AUTH_CONNECTION'

  super(attributes)

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

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

  self.password_secret = attributes[:'passwordSecret'] if attributes[:'passwordSecret']

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

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

  self.auth_header = attributes[:'authHeader'] if attributes[:'authHeader']

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

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

Instance Attribute Details

#auth_header ⇒ String

Optional header name if used other than default header(Authorization).

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 21

def auth_header
  @auth_header
end

#password_secret ⇒ OCI::DataIntegration::Models::SensitiveAttribute

Returns:



17
18
19
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 17

def password_secret
  @password_secret
end

#username ⇒ String

Username for the connection.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 14

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'primary_schema': :'primarySchema',
    'connection_properties': :'connectionProperties',
    'is_default': :'isDefault',
    'metadata': :'metadata',
    'key_map': :'keyMap',
    'username': :'username',
    'password_secret': :'passwordSecret',
    'auth_header': :'authHeader'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'primary_schema': :'OCI::DataIntegration::Models::Schema',
    'connection_properties': :'Array<OCI::DataIntegration::Models::ConnectionProperty>',
    'is_default': :'BOOLEAN',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, String>',
    'username': :'String',
    'password_secret': :'OCI::DataIntegration::Models::SensitiveAttribute',
    'auth_header': :'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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 127

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    primary_schema == other.primary_schema &&
    connection_properties == other.connection_properties &&
    is_default == other.is_default &&
    metadata == other.metadata &&
    key_map == other.key_map &&
    username == other.username &&
    password_secret == other.password_secret &&
    auth_header == other.auth_header
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 173

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


153
154
155
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 162

def hash
  [model_type, key, model_version, parent_ref, name, description, object_version, object_status, identifier, primary_schema, connection_properties, is_default, metadata, key_map, username, password_secret, auth_header].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 206

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



200
201
202
 
# File 'lib/oci/data_integration/models/connection_from_rest_basic_auth.rb', line 200

def to_s
  to_hash.to_s
end