Class: Authentik::Api::AuthenticatorStaticStageRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/authentik/api/models/authenticator_static_stage_request.rb

Overview

AuthenticatorStaticStage Serializer

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 = {}) ⇒ AuthenticatorStaticStageRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 65

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::AuthenticatorStaticStageRequest` 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::AuthenticatorStaticStageRequest`. 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?(:'configure_flow')
    self.configure_flow = attributes[:'configure_flow']
  end

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

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

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

Instance Attribute Details

#configure_flow ⇒ Object

Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.



16
17
18
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 16

def configure_flow
  @configure_flow
end

#friendly_name ⇒ Object

Returns the value of attribute friendly_name.



18
19
20
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 18

def friendly_name
  @friendly_name
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#token_count ⇒ Object

Returns the value of attribute token_count.



20
21
22
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 20

def token_count
  @token_count
end

#token_length ⇒ Object

Returns the value of attribute token_length.



22
23
24
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 22

def token_length
  @token_length
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



36
37
38
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 36

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 41

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 25

def self.attribute_map
  {
    :'name' => :'name',
    :'configure_flow' => :'configure_flow',
    :'friendly_name' => :'friendly_name',
    :'token_count' => :'token_count',
    :'token_length' => :'token_length'
  }
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 224

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



57
58
59
60
61
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 57

def self.openapi_nullable
  Set.new([
    :'configure_flow',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 46

def self.openapi_types
  {
    :'name' => :'String',
    :'configure_flow' => :'String',
    :'friendly_name' => :'String',
    :'token_count' => :'Integer',
    :'token_length' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      configure_flow == o.configure_flow &&
      friendly_name == o.friendly_name &&
      token_count == o.token_count &&
      token_length == o.token_length
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 217

def hash
  [name, configure_flow, friendly_name, token_count, token_length].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



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
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 104

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 !@token_count.nil? && @token_count > 2147483647
    invalid_properties.push('invalid value for "token_count", must be smaller than or equal to 2147483647.')
  end

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

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

  if !@token_length.nil? && @token_length < 0
    invalid_properties.push('invalid value for "token_length", must be greater than or equal to 0.')
  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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 246

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



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/authentik/api/models/authenticator_static_stage_request.rb', line 136

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 !@token_count.nil? && @token_count > 2147483647
  return false if !@token_count.nil? && @token_count < 0
  return false if !@token_length.nil? && @token_length > 100
  return false if !@token_length.nil? && @token_length < 0
  true
end