Class: Akeyless::UpdateRole

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/update_role.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateRole

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
189
 
# File 'lib/akeyless/models/update_role.rb', line 113

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

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

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

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

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

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

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

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

  if attributes.key?(:'new_comment')
    self.new_comment = attributes[:'new_comment']
  else
    self.new_comment = 'default_comment'
  end

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

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

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

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

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

Instance Attribute Details

#analytics_access ⇒ Object

Allow this role to view analytics. Currently only ‘none’, ‘own’, ‘all’ values are supported, allowing associated auth methods to view reports produced by the same auth methods.



19
20
21
 
# File 'lib/akeyless/models/update_role.rb', line 19

def analytics_access
  @analytics_access
end

#audit_access ⇒ Object

Allow this role to view audit logs. Currently only ‘none’, ‘own’ and ‘all’ values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.



22
23
24
 
# File 'lib/akeyless/models/update_role.rb', line 22

def audit_access
  @audit_access
end

#description ⇒ Object

Description of the object



25
26
27
 
# File 'lib/akeyless/models/update_role.rb', line 25

def description
  @description
end

#event_center_access ⇒ Object

Allow this role to view Event Center. Currently only ‘none’, ‘own’ and ‘all’ values are supported



28
29
30
 
# File 'lib/akeyless/models/update_role.rb', line 28

def event_center_access
  @event_center_access
end

#event_forwarder_access ⇒ Object

Allow this role to manage Event Forwarders. Currently only ‘none’ and ‘all’ values are supported.



31
32
33
 
# File 'lib/akeyless/models/update_role.rb', line 31

def event_forwarder_access
  @event_forwarder_access
end

#gw_analytics_access ⇒ Object

Allow this role to view gw analytics. Currently only ‘none’, ‘own’, ‘all’ values are supported, allowing associated auth methods to view reports produced by the same auth methods.



34
35
36
 
# File 'lib/akeyless/models/update_role.rb', line 34

def gw_analytics_access
  @gw_analytics_access
end

#json ⇒ Object

Set output format to JSON



37
38
39
 
# File 'lib/akeyless/models/update_role.rb', line 37

def json
  @json
end

#name ⇒ Object

Role name



40
41
42
 
# File 'lib/akeyless/models/update_role.rb', line 40

def name
  @name
end

#new_comment ⇒ Object

Deprecated - use description



43
44
45
 
# File 'lib/akeyless/models/update_role.rb', line 43

def new_comment
  @new_comment
end

#new_name ⇒ Object

New Role name



46
47
48
 
# File 'lib/akeyless/models/update_role.rb', line 46

def new_name
  @new_name
end

#sra_reports_access ⇒ Object

Allow this role to view SRA Clusters. Currently only ‘none’, ‘own’, ‘all’ values are supported.



49
50
51
 
# File 'lib/akeyless/models/update_role.rb', line 49

def sra_reports_access
  @sra_reports_access
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



52
53
54
 
# File 'lib/akeyless/models/update_role.rb', line 52

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



55
56
57
 
# File 'lib/akeyless/models/update_role.rb', line 55

def uid_token
  @uid_token
end

#usage_reports_access ⇒ Object

Allow this role to view Usage Report. Currently only ‘none’ and ‘all’ values are supported.



58
59
60
 
# File 'lib/akeyless/models/update_role.rb', line 58

def usage_reports_access
  @usage_reports_access
end

Class Method Details

._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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/akeyless/models/update_role.rb', line 271

def self._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
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/akeyless/models/update_role.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/akeyless/models/update_role.rb', line 61

def self.attribute_map
  {
    :'analytics_access' => :'analytics-access',
    :'audit_access' => :'audit-access',
    :'description' => :'description',
    :'event_center_access' => :'event-center-access',
    :'event_forwarder_access' => :'event-forwarder-access',
    :'gw_analytics_access' => :'gw-analytics-access',
    :'json' => :'json',
    :'name' => :'name',
    :'new_comment' => :'new-comment',
    :'new_name' => :'new-name',
    :'sra_reports_access' => :'sra-reports-access',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'usage_reports_access' => :'usage-reports-access'
  }
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/akeyless/models/update_role.rb', line 247

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



106
107
108
109
 
# File 'lib/akeyless/models/update_role.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/akeyless/models/update_role.rb', line 86

def self.openapi_types
  {
    :'analytics_access' => :'String',
    :'audit_access' => :'String',
    :'description' => :'String',
    :'event_center_access' => :'String',
    :'event_forwarder_access' => :'String',
    :'gw_analytics_access' => :'String',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'new_comment' => :'String',
    :'new_name' => :'String',
    :'sra_reports_access' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'usage_reports_access' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/akeyless/models/update_role.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      analytics_access == o.analytics_access &&
      audit_access == o.audit_access &&
      description == o.description &&
      event_center_access == o.event_center_access &&
      event_forwarder_access == o.event_forwarder_access &&
      gw_analytics_access == o.gw_analytics_access &&
      json == o.json &&
      name == o.name &&
      new_comment == o.new_comment &&
      new_name == o.new_name &&
      sra_reports_access == o.sra_reports_access &&
      token == o.token &&
      uid_token == o.uid_token &&
      usage_reports_access == o.usage_reports_access
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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/akeyless/models/update_role.rb', line 342

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/akeyless/models/update_role.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/akeyless/models/update_role.rb', line 240

def hash
  [analytics_access, audit_access, description, event_center_access, event_forwarder_access, gw_analytics_access, json, name, new_comment, new_name, sra_reports_access, token, uid_token, usage_reports_access].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



193
194
195
196
197
198
199
200
201
 
# File 'lib/akeyless/models/update_role.rb', line 193

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

  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



318
319
320
 
# File 'lib/akeyless/models/update_role.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/akeyless/models/update_role.rb', line 324

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



312
313
314
 
# File 'lib/akeyless/models/update_role.rb', line 312

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



205
206
207
208
209
 
# File 'lib/akeyless/models/update_role.rb', line 205

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  true
end