Class: Akeyless::ListItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
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
190
191
 
# File 'lib/akeyless/models/list_items.rb', line 111

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

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

  if attributes.key?(:'auto_pagination')
    self.auto_pagination = attributes[:'auto_pagination']
  else
    self.auto_pagination = 'enabled'
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accessibility ⇒ Object

for personal password manager



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

def accessibility
  @accessibility
end

#advanced_filter ⇒ Object

Filter by item name/username/website or part of it



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

def advanced_filter
  @advanced_filter
end

#auto_pagination ⇒ Object

Retrieve all items using pagination, when disabled retrieving only first 1000 items



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

def auto_pagination
  @auto_pagination
end

#filter ⇒ Object

Filter by item name or part of it



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

def filter
  @filter
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#minimal_view ⇒ Object

Returns the value of attribute minimal_view.



33
34
35
 
# File 'lib/akeyless/models/list_items.rb', line 33

def minimal_view
  @minimal_view
end

#pagination_token ⇒ Object

Next page reference



36
37
38
 
# File 'lib/akeyless/models/list_items.rb', line 36

def pagination_token
  @pagination_token
end

#path ⇒ Object

Path to folder



39
40
41
 
# File 'lib/akeyless/models/list_items.rb', line 39

def path
  @path
end

#sra_only ⇒ Object

Filter by items with SRA functionality enabled



42
43
44
 
# File 'lib/akeyless/models/list_items.rb', line 42

def sra_only
  @sra_only
end

#sub_types ⇒ Object

Returns the value of attribute sub_types.



44
45
46
 
# File 'lib/akeyless/models/list_items.rb', line 44

def sub_types
  @sub_types
end

#tag ⇒ Object

Filter by item tag



47
48
49
 
# File 'lib/akeyless/models/list_items.rb', line 47

def tag
  @tag
end

#token ⇒ Object

Authentication token (see /auth and /configure)



50
51
52
 
# File 'lib/akeyless/models/list_items.rb', line 50

def token
  @token
end

#type ⇒ Object

The item types list of the requested items. In case it is empty, all types of items will be returned. options: [key, static-secret, dynamic-secret, classic-key]



53
54
55
 
# File 'lib/akeyless/models/list_items.rb', line 53

def type
  @type
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



56
57
58
 
# File 'lib/akeyless/models/list_items.rb', line 56

def uid_token
  @uid_token
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



268
269
270
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
 
# File 'lib/akeyless/models/list_items.rb', line 268

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



79
80
81
 
# File 'lib/akeyless/models/list_items.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'advanced_filter' => :'advanced-filter',
    :'auto_pagination' => :'auto-pagination',
    :'filter' => :'filter',
    :'json' => :'json',
    :'minimal_view' => :'minimal-view',
    :'pagination_token' => :'pagination-token',
    :'path' => :'path',
    :'sra_only' => :'sra-only',
    :'sub_types' => :'sub_types',
    :'tag' => :'tag',
    :'token' => :'token',
    :'type' => :'type',
    :'uid_token' => :'uid-token'
  }
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/akeyless/models/list_items.rb', line 244

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



104
105
106
107
 
# File 'lib/akeyless/models/list_items.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'accessibility' => :'String',
    :'advanced_filter' => :'String',
    :'auto_pagination' => :'String',
    :'filter' => :'String',
    :'json' => :'Boolean',
    :'minimal_view' => :'Boolean',
    :'pagination_token' => :'String',
    :'path' => :'String',
    :'sra_only' => :'Boolean',
    :'sub_types' => :'Array<String>',
    :'tag' => :'String',
    :'token' => :'String',
    :'type' => :'Array<String>',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/akeyless/models/list_items.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      advanced_filter == o.advanced_filter &&
      auto_pagination == o.auto_pagination &&
      filter == o.filter &&
      json == o.json &&
      minimal_view == o.minimal_view &&
      pagination_token == o.pagination_token &&
      path == o.path &&
      sra_only == o.sra_only &&
      sub_types == o.sub_types &&
      tag == o.tag &&
      token == o.token &&
      type == o.type &&
      uid_token == o.uid_token
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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/akeyless/models/list_items.rb', line 339

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


231
232
233
 
# File 'lib/akeyless/models/list_items.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



237
238
239
 
# File 'lib/akeyless/models/list_items.rb', line 237

def hash
  [accessibility, advanced_filter, auto_pagination, filter, json, minimal_view, pagination_token, path, sra_only, sub_types, tag, token, type, uid_token].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



195
196
197
198
199
 
# File 'lib/akeyless/models/list_items.rb', line 195

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



315
316
317
 
# File 'lib/akeyless/models/list_items.rb', line 315

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/akeyless/models/list_items.rb', line 321

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



309
310
311
 
# File 'lib/akeyless/models/list_items.rb', line 309

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



203
204
205
206
 
# File 'lib/akeyless/models/list_items.rb', line 203

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end