class InfluxDB2::API::Authorization

Attributes

created_at[RW]
description[RW]

A description of the token.

id[RW]
org[RW]

Name of the org token is scoped to.

org_id[RW]

ID of org that authorization is scoped to.

permissions[R]

List of permissions for an auth. An auth must have at least one Permission.

status[R]

If inactive the token is inactive and requests using the token will be rejected.

token[RW]

Passed via the Authorization Header and Token Authentication type.

updated_at[RW]
user[RW]

Name of user that created and owns the token.

user_id[RW]

ID of user that created and owns the token.

Public Class Methods

attribute_map() click to toggle source

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

# File 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/influxdb2/apis/generated/models/authorization.rb, line 278
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File 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
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/influxdb2/apis/generated/models/authorization.rb, line 115
def self.openapi_all_of
  [
  :'AuthorizationAllOf',
  :'AuthorizationUpdateRequest'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/influxdb2/apis/generated/models/authorization.rb, line 109
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/influxdb2/apis/generated/models/authorization.rb, line 265
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File 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
permissions=(permissions) click to toggle source

Custom attribute writer method with validation @param [Object] permissions Value to be assigned

# File lib/influxdb2/apis/generated/models/authorization.rb, line 232
def permissions=(permissions)
  if permissions.nil?
    fail ArgumentError, 'permissions cannot be nil'
  end

  if permissions.length < 1
    fail ArgumentError, 'invalid value for "permissions", number of items must be greater than or equal to 1.'
  end

  @permissions = permissions
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/influxdb2/apis/generated/models/authorization.rb, line 222
def status=(status)
  validator = EnumAttributeValidator.new('String', ["active", "inactive"])
  unless validator.valid?(status)
    fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/influxdb2/apis/generated/models/authorization.rb, line 353
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/influxdb2/apis/generated/models/authorization.rb, line 347
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File 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