Class: InfluxDB2::API::Authorization

Inherits:
Object
  • Object
show all
Defined in:
apis/lib/influxdb2/apis/generated/models/authorization.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Authorization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 124

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'active'
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



24
25
26
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 24

def created_at
  @created_at
end

#description ⇒ Object

A description of the token.



22
23
24
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 22

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



34
35
36
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 34

def id
  @id
end

#links ⇒ Object

Returns the value of attribute links.



48
49
50
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 48

def links
  @links
end

#org ⇒ Object

Name of the organization that the token is scoped to.



46
47
48
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 46

def org
  @org
end

#org_id ⇒ Object

ID of the organization that the authorization is scoped to.



29
30
31
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 29

def org_id
  @org_id
end

#permissions ⇒ Object

List of permissions for an authorization. An authorization must have at least one permission.



32
33
34
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 32

def permissions
  @permissions
end

#status ⇒ Object

Status of the token. If `inactive`, requests using the token will be rejected.



19
20
21
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 19

def status
  @status
end

#token ⇒ Object

Token used to authenticate API requests.



37
38
39
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 37

def token
  @token
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



26
27
28
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 26

def updated_at
  @updated_at
end

#user ⇒ Object

Name of the user that created and owns the token.



43
44
45
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 43

def user
  @user
end

#user_id ⇒ Object

ID of the user that created and owns the token.



40
41
42
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 40

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 73

def self.attribute_map
  {
    :'status' => :'status',
    :'description' => :'description',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'org_id' => :'orgID',
    :'permissions' => :'permissions',
    :'id' => :'id',
    :'token' => :'token',
    :'user_id' => :'userID',
    :'user' => :'user',
    :'org' => :'org',
    :'links' => :'links',
  }
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



278
279
280
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 278

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 115

def self.openapi_all_of
  [
  :'AuthorizationAllOf',
  :'AuthorizationUpdateRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 91

def self.openapi_types
  {
    :'status' => :'String',
    :'description' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'org_id' => :'String',
    :'permissions' => :'Array<Permission>',
    :'id' => :'String',
    :'token' => :'String',
    :'user_id' => :'String',
    :'user' => :'String',
    :'org' => :'String',
    :'links' => :'AuthorizationAllOfLinks'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      description == o.description &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      org_id == o.org_id &&
      permissions == o.permissions &&
      id == o.id &&
      token == o.token &&
      user_id == o.user_id &&
      user == o.user &&
      org == o.org &&
      links == o.links
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 308

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    InfluxDB2::API.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 377

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 285

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


265
266
267
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 271

def hash
  [status, description, created_at, updated_at, org_id, permissions, id, token, user_id, user, org, links].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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 192

def list_invalid_properties
  invalid_properties = Array.new
  if @org_id.nil?
    invalid_properties.push('invalid value for "org_id", org_id cannot be nil.')
  end

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

  if @permissions.length < 1
    invalid_properties.push('invalid value for "permissions", number of items must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



353
354
355
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 353

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 359

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



347
348
349
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 347

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



211
212
213
214
215
216
217
218
 
# File 'apis/lib/influxdb2/apis/generated/models/authorization.rb', line 211

def valid?
  status_validator = EnumAttributeValidator.new('String', ["active", "inactive"])
  return false unless status_validator.valid?(@status)
  return false if @org_id.nil?
  return false if @permissions.nil?
  return false if @permissions.length < 1
  true
end