Class: CloudsmithApi::RepositoryToken

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/models/repository_token.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RepositoryToken

Initializes the object

Parameters:

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

    Model attributes in the form of hash



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 173

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'clients')
    self.clients = attributes[:'clients']
  end

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

  if attributes.has_key?(:'created_by')
    self.created_by = attributes[:'created_by']
  end

  if attributes.has_key?(:'created_by_url')
    self.created_by_url = attributes[:'created_by_url']
  end

  if attributes.has_key?(:'default')
    self.default = attributes[:'default']
  end

  if attributes.has_key?(:'downloads')
    self.downloads = attributes[:'downloads']
  end

  if attributes.has_key?(:'has_limits')
    self.has_limits = attributes[:'has_limits']
  end

  if attributes.has_key?(:'identifier')
    self.identifier = attributes[:'identifier']
  end

  if attributes.has_key?(:'is_active')
    self.is_active = attributes[:'is_active']
  end

  if attributes.has_key?(:'is_limited')
    self.is_limited = attributes[:'is_limited']
  end

  if attributes.has_key?(:'limit_date_range_from')
    self.limit_date_range_from = attributes[:'limit_date_range_from']
  end

  if attributes.has_key?(:'limit_date_range_to')
    self.limit_date_range_to = attributes[:'limit_date_range_to']
  end

  if attributes.has_key?(:'limit_num_clients')
    self.limit_num_clients = attributes[:'limit_num_clients']
  end

  if attributes.has_key?(:'limit_num_downloads')
    self.limit_num_downloads = attributes[:'limit_num_downloads']
  end

  if attributes.has_key?(:'limit_package_query')
    self.limit_package_query = attributes[:'limit_package_query']
  end

  if attributes.has_key?(:'limit_path_query')
    self.limit_path_query = attributes[:'limit_path_query']
  end

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

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

  if attributes.has_key?(:'refresh_url')
    self.refresh_url = attributes[:'refresh_url']
  end

  if attributes.has_key?(:'self_url')
    self.self_url = attributes[:'self_url']
  end

  if attributes.has_key?(:'slug_perm')
    self.slug_perm = attributes[:'slug_perm']
  end

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

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

  if attributes.has_key?(:'updated_by')
    self.updated_by = attributes[:'updated_by']
  end

  if attributes.has_key?(:'updated_by_url')
    self.updated_by_url = attributes[:'updated_by_url']
  end

  if attributes.has_key?(:'usage')
    self.usage = attributes[:'usage']
  end

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

  if attributes.has_key?(:'user_url')
    self.user_url = attributes[:'user_url']
  end

end

Instance Attribute Details

#clients ⇒ Object

Returns the value of attribute clients.



19
20
21
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 19

def clients
  @clients
end

#created_at ⇒ Object

The datetime the token was updated at.



22
23
24
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 22

def created_at
  @created_at
end

#created_by ⇒ Object

Returns the value of attribute created_by.



25
26
27
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 25

def created_by
  @created_by
end

#created_by_url ⇒ Object

Returns the value of attribute created_by_url.



28
29
30
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 28

def created_by_url
  @created_by_url
end

#default ⇒ Object

If selected this is the default token for this repository.



31
32
33
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 31

def default
  @default
end

#downloads ⇒ Object

Returns the value of attribute downloads.



34
35
36
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 34

def downloads
  @downloads
end

#has_limits ⇒ Object

Returns the value of attribute has_limits.



37
38
39
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 37

def has_limits
  @has_limits
end

#identifier ⇒ Object

Returns the value of attribute identifier.



40
41
42
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 40

def identifier
  @identifier
end

#is_active ⇒ Object

If enabled, the token will allow downloads based on configured restrictions (if any).



43
44
45
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 43

def is_active
  @is_active
end

#is_limited ⇒ Object

Returns the value of attribute is_limited.



46
47
48
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 46

def is_limited
  @is_limited
end

#limit_date_range_from ⇒ Object

The starting date/time the token is allowed to be used from.



49
50
51
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 49

def limit_date_range_from
  @limit_date_range_from
end

#limit_date_range_to ⇒ Object

The ending date/time the token is allowed to be used until.



52
53
54
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 52

def limit_date_range_to
  @limit_date_range_to
end

#limit_num_clients ⇒ Object

The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.



55
56
57
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 55

def limit_num_clients
  @limit_num_clients
end

#limit_num_downloads ⇒ Object

The maximum number of downloads allowed for the token. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.



58
59
60
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 58

def limit_num_downloads
  @limit_num_downloads
end

#limit_package_query ⇒ Object

The package-based search query to apply to restrict downloads to. This uses the same syntax as the standard search used for repositories, and also supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. This will still allow access to non-package files, such as metadata.



61
62
63
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 61

def limit_package_query
  @limit_package_query
end

#limit_path_query ⇒ Object

The path-based search query to apply to restrict downloads to. This supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. The path evaluated does not include the domain name, the namespace, the entitlement code used, the package format, etc. and it always starts with a forward slash.



64
65
66
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 64

def limit_path_query
  @limit_path_query
end

#metadata ⇒ Object

Returns the value of attribute metadata.



67
68
69
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 67

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



70
71
72
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 70

def name
  @name
end

#refresh_url ⇒ Object

Returns the value of attribute refresh_url.



73
74
75
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 73

def refresh_url
  @refresh_url
end

#self_url ⇒ Object

Returns the value of attribute self_url.



76
77
78
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 76

def self_url
  @self_url
end

#slug_perm ⇒ Object

Returns the value of attribute slug_perm.



79
80
81
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 79

def slug_perm
  @slug_perm
end

#token ⇒ Object

Returns the value of attribute token.



82
83
84
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 82

def token
  @token
end

#updated_at ⇒ Object

The datetime the token was updated at.



85
86
87
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 85

def updated_at
  @updated_at
end

#updated_by ⇒ Object

Returns the value of attribute updated_by.



88
89
90
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 88

def updated_by
  @updated_by
end

#updated_by_url ⇒ Object

Returns the value of attribute updated_by_url.



91
92
93
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 91

def updated_by_url
  @updated_by_url
end

#usage ⇒ Object

Returns the value of attribute usage.



94
95
96
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 94

def usage
  @usage
end

#user ⇒ Object

Returns the value of attribute user.



97
98
99
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 97

def user
  @user
end

#user_url ⇒ Object

Returns the value of attribute user_url.



100
101
102
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 100

def user_url
  @user_url
end

Class Method Details

.attribute_map ⇒ Object

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



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
134
135
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 104

def self.attribute_map
  {
    :'clients' => :'clients',
    :'created_at' => :'created_at',
    :'created_by' => :'created_by',
    :'created_by_url' => :'created_by_url',
    :'default' => :'default',
    :'downloads' => :'downloads',
    :'has_limits' => :'has_limits',
    :'identifier' => :'identifier',
    :'is_active' => :'is_active',
    :'is_limited' => :'is_limited',
    :'limit_date_range_from' => :'limit_date_range_from',
    :'limit_date_range_to' => :'limit_date_range_to',
    :'limit_num_clients' => :'limit_num_clients',
    :'limit_num_downloads' => :'limit_num_downloads',
    :'limit_package_query' => :'limit_package_query',
    :'limit_path_query' => :'limit_path_query',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'refresh_url' => :'refresh_url',
    :'self_url' => :'self_url',
    :'slug_perm' => :'slug_perm',
    :'token' => :'token',
    :'updated_at' => :'updated_at',
    :'updated_by' => :'updated_by',
    :'updated_by_url' => :'updated_by_url',
    :'usage' => :'usage',
    :'user' => :'user',
    :'user_url' => :'user_url'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 138

def self.swagger_types
  {
    :'clients' => :'Integer',
    :'created_at' => :'String',
    :'created_by' => :'String',
    :'created_by_url' => :'String',
    :'default' => :'BOOLEAN',
    :'downloads' => :'Integer',
    :'has_limits' => :'BOOLEAN',
    :'identifier' => :'Integer',
    :'is_active' => :'BOOLEAN',
    :'is_limited' => :'BOOLEAN',
    :'limit_date_range_from' => :'String',
    :'limit_date_range_to' => :'String',
    :'limit_num_clients' => :'Integer',
    :'limit_num_downloads' => :'Integer',
    :'limit_package_query' => :'String',
    :'limit_path_query' => :'String',
    :'metadata' => :'Object',
    :'name' => :'String',
    :'refresh_url' => :'String',
    :'self_url' => :'String',
    :'slug_perm' => :'String',
    :'token' => :'String',
    :'updated_at' => :'String',
    :'updated_by' => :'String',
    :'updated_by_url' => :'String',
    :'usage' => :'String',
    :'user' => :'String',
    :'user_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
344
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      clients == o.clients &&
      created_at == o.created_at &&
      created_by == o.created_by &&
      created_by_url == o.created_by_url &&
      default == o.default &&
      downloads == o.downloads &&
      has_limits == o.has_limits &&
      identifier == o.identifier &&
      is_active == o.is_active &&
      is_limited == o.is_limited &&
      limit_date_range_from == o.limit_date_range_from &&
      limit_date_range_to == o.limit_date_range_to &&
      limit_num_clients == o.limit_num_clients &&
      limit_num_downloads == o.limit_num_downloads &&
      limit_package_query == o.limit_package_query &&
      limit_path_query == o.limit_path_query &&
      metadata == o.metadata &&
      name == o.name &&
      refresh_url == o.refresh_url &&
      self_url == o.self_url &&
      slug_perm == o.slug_perm &&
      token == o.token &&
      updated_at == o.updated_at &&
      updated_by == o.updated_by &&
      updated_by_url == o.updated_by_url &&
      usage == o.usage &&
      user == o.user &&
      user_url == o.user_url
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 382

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CloudsmithApi.const_get(type).new
    temp_model.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



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 448

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 361

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


348
349
350
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 354

def hash
  [clients, created_at, created_by, created_by_url, default, downloads, has_limits, identifier, is_active, is_limited, limit_date_range_from, limit_date_range_to, limit_num_clients, limit_num_downloads, limit_package_query, limit_path_query, metadata, name, refresh_url, self_url, slug_perm, token, updated_at, updated_by, updated_by_url, usage, user, user_url].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



295
296
297
298
299
300
301
302
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 295

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

  return 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



428
429
430
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 428

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



434
435
436
437
438
439
440
441
442
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 434

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



422
423
424
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 422

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



306
307
308
309
 
# File 'lib/cloudsmith-api/models/repository_token.rb', line 306

def valid?
  return false if @name.nil?
  return true
end