Class: InfluxDB2::API::ResourceOwner

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceOwner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
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
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 93

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

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

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

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

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

  if attributes.key?(:'role')
    self.role = attributes[:'role']
  else
    self.role = 'owner'
  end
end

Instance Attribute Details

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 18

def id
  @id
end

Returns the value of attribute links.



27
28
29
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 27

def links
  @links
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#oauth_idObject

Returns the value of attribute oauth_id.



20
21
22
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 20

def oauth_id
  @oauth_id
end

#roleObject

Returns the value of attribute role.



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

def role
  @role
end

#statusObject

If inactive the user is inactive.



25
26
27
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 25

def status
  @status
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 54

def self.attribute_map
  {
    :'id' => :'id',
    :'oauth_id' => :'oauthID',
    :'name' => :'name',
    :'status' => :'status',
    :'links' => :'links',
    :'role' => :'role',
  }
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



205
206
207
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 205

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



84
85
86
87
88
89
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 84

def self.openapi_all_of
  [
  :'ResourceOwnerAllOf',
  :'UserResponse'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



78
79
80
81
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 78

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

.openapi_typesObject

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 66

def self.openapi_types
  {
    :'id' => :'String',
    :'oauth_id' => :'String',
    :'name' => :'String',
    :'status' => :'String',
    :'links' => :'UserResponseLinks',
    :'role' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



179
180
181
182
183
184
185
186
187
188
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      oauth_id == o.oauth_id &&
      name == o.name &&
      status == o.status &&
      links == o.links &&
      role == o.role
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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 235

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



304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 304

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 212

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


192
193
194
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 192

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



198
199
200
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 198

def hash
  [id, oauth_id, name, status, links, role].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



137
138
139
140
141
142
143
144
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 137

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



280
281
282
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 280

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 286

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



274
275
276
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 274

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



148
149
150
151
152
153
154
155
# File 'lib/influxdb2/apis/generated/models/resource_owner.rb', line 148

def valid?
  return false if @name.nil?
  status_validator = EnumAttributeValidator.new('String', ["active", "inactive"])
  return false unless status_validator.valid?(@status)
  role_validator = EnumAttributeValidator.new('String', ["owner"])
  return false unless role_validator.valid?(@role)
  true
end