Class: Authentik::Api::EndpointRequest

Inherits:
ApiModelBase show all
Defined in:
lib/authentik/api/models/endpoint_request.rb

Overview

Endpoint Serializer

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ EndpointRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
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
148
149
150
151
152
153
154
155
156
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 97

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::EndpointRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Authentik::Api::EndpointRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'provider')
    self.provider = attributes[:'provider']
  else
    self.provider = nil
  end

  if attributes.key?(:'protocol')
    self.protocol = attributes[:'protocol']
  else
    self.protocol = nil
  end

  if attributes.key?(:'host')
    self.host = attributes[:'host']
  else
    self.host = nil
  end

  if attributes.key?(:'settings')
    if (value = attributes[:'settings']).is_a?(Hash)
      self.settings = value
    end
  end

  if attributes.key?(:'property_mappings')
    if (value = attributes[:'property_mappings']).is_a?(Array)
      self.property_mappings = value
    end
  end

  if attributes.key?(:'auth_mode')
    self.auth_mode = attributes[:'auth_mode']
  else
    self.auth_mode = nil
  end

  if attributes.key?(:'maximum_connections')
    self.maximum_connections = attributes[:'maximum_connections']
  end
end

Instance Attribute Details

#auth_mode ⇒ Object

Returns the value of attribute auth_mode.



25
26
27
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 25

def auth_mode
  @auth_mode
end

#host ⇒ Object

Returns the value of attribute host.



19
20
21
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 19

def host
  @host
end

#maximum_connections ⇒ Object

Returns the value of attribute maximum_connections.



27
28
29
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 27

def maximum_connections
  @maximum_connections
end

#name ⇒ Object

Returns the value of attribute name.



13
14
15
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 13

def name
  @name
end

#property_mappings ⇒ Object

Returns the value of attribute property_mappings.



23
24
25
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 23

def property_mappings
  @property_mappings
end

#protocol ⇒ Object

Returns the value of attribute protocol.



17
18
19
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 17

def protocol
  @protocol
end

#provider ⇒ Object

Returns the value of attribute provider.



15
16
17
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 15

def provider
  @provider
end

#settings ⇒ Object

Returns the value of attribute settings.



21
22
23
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 21

def settings
  @settings
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 52

def self.attribute_map
  {
    :'name' => :'name',
    :'provider' => :'provider',
    :'protocol' => :'protocol',
    :'host' => :'host',
    :'settings' => :'settings',
    :'property_mappings' => :'property_mappings',
    :'auth_mode' => :'auth_mode',
    :'maximum_connections' => :'maximum_connections'
  }
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 324

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 90

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 76

def self.openapi_types
  {
    :'name' => :'String',
    :'provider' => :'Integer',
    :'protocol' => :'ProtocolEnum',
    :'host' => :'String',
    :'settings' => :'Hash<String, Object>',
    :'property_mappings' => :'Array<String>',
    :'auth_mode' => :'EndpointAuthModeEnum',
    :'maximum_connections' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      provider == o.provider &&
      protocol == o.protocol &&
      host == o.host &&
      settings == o.settings &&
      property_mappings == o.property_mappings &&
      auth_mode == o.auth_mode &&
      maximum_connections == o.maximum_connections
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 317

def hash
  [name, provider, protocol, host, settings, property_mappings, auth_mode, maximum_connections].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
193
194
195
196
197
198
199
200
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 160

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
  end

  if @provider.nil?
    invalid_properties.push('invalid value for "provider", provider cannot be nil.')
  end

  if @protocol.nil?
    invalid_properties.push('invalid value for "protocol", protocol cannot be nil.')
  end

  if @host.nil?
    invalid_properties.push('invalid value for "host", host cannot be nil.')
  end

  if @host.to_s.length < 1
    invalid_properties.push('invalid value for "host", the character length must be greater than or equal to 1.')
  end

  if @auth_mode.nil?
    invalid_properties.push('invalid value for "auth_mode", auth_mode cannot be nil.')
  end

  if !@maximum_connections.nil? && @maximum_connections > 2147483647
    invalid_properties.push('invalid value for "maximum_connections", must be smaller than or equal to 2147483647.')
  end

  if !@maximum_connections.nil? && @maximum_connections < -2147483648
    invalid_properties.push('invalid value for "maximum_connections", must be greater than or equal to -2147483648.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 346

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/authentik/api/models/endpoint_request.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @provider.nil?
  return false if @protocol.nil?
  return false if @host.nil?
  return false if @host.to_s.length < 1
  return false if @auth_mode.nil?
  return false if !@maximum_connections.nil? && @maximum_connections > 2147483647
  return false if !@maximum_connections.nil? && @maximum_connections < -2147483648
  true
end