Class: OCI::DataIntegration::Models::ConnectionFromOAuth2Details

Inherits:
ConnectionDetails show all
Defined in:
lib/oci/data_integration/models/connection_from_o_auth2_details.rb

Overview

The connection details for a OAuth connection.

Constant Summary collapse

GRANT_TYPE_ENUM = 
[
  GRANT_TYPE_CLIENT_CREDENTIALS = 'CLIENT_CREDENTIALS'.freeze
].freeze

Constants inherited from ConnectionDetails

OCI::DataIntegration::Models::ConnectionDetails::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConnectionDetails

#connection_properties, #description, #identifier, #is_default, #key, #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 ConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ConnectionFromOAuth2Details

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



110
111
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
140
141
142
143
144
145
146
147
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 110

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

  attributes['modelType'] = 'OAUTH2_CONNECTION'

  super(attributes)

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

  self.access_token_url = attributes[:'accessTokenUrl'] if attributes[:'accessTokenUrl']

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

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

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

  self.grant_type = attributes[:'grantType'] if attributes[:'grantType']
  self.grant_type = "CLIENT_CREDENTIALS" if grant_type.nil? && !attributes.key?(:'grantType') # rubocop:disable Style/StringLiterals

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

  self.grant_type = attributes[:'grant_type'] if attributes[:'grant_type']
  self.grant_type = "CLIENT_CREDENTIALS" if grant_type.nil? && !attributes.key?(:'grantType') && !attributes.key?(:'grant_type') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#access_token_url ⇒ String

[Required] Specifies the endpoint used to exchange authentication credentials for access tokens

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 18

def access_token_url
  @access_token_url
end

#client_id ⇒ String

Specifies the client ID key for specific application

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 22

def client_id
  @client_id
end

#client_secret ⇒ OCI::DataIntegration::Models::SensitiveAttribute

Returns:



25
26
27
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 25

def client_secret
  @client_secret
end

#grant_type ⇒ String

Specifies the OAuth2 grant mechanism. Example CLIENT_CREDENTIALS, Implicit Flow etc.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 33

def grant_type
  @grant_type
end

#scope ⇒ String

Specifies the OAuth scopes that limit the permissions granted by an access token.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 29

def scope
  @scope
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 36

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',
    'access_token_url': :'accessTokenUrl',
    'client_id': :'clientId',
    'client_secret': :'clientSecret',
    'scope': :'scope',
    'grant_type': :'grantType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'access_token_url': :'String',
    'client_id': :'String',
    'client_secret': :'OCI::DataIntegration::Models::SensitiveAttribute',
    'scope': :'String',
    'grant_type': :'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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 164

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 &&
    access_token_url == other.access_token_url &&
    client_id == other.client_id &&
    client_secret == other.client_secret &&
    scope == other.scope &&
    grant_type == other.grant_type
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 211

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


191
192
193
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [model_type, key, model_version, parent_ref, name, description, object_version, object_status, identifier, primary_schema, connection_properties, is_default, metadata, access_token_url, client_id, client_secret, scope, grant_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 244

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



238
239
240
 
# File 'lib/oci/data_integration/models/connection_from_o_auth2_details.rb', line 238

def to_s
  to_hash.to_s
end