Class: CloudsmithApi::EntitlementsCreate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EntitlementsCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'eula_required')
    self.eula_required = attributes[:'eula_required']
  end

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

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

  if attributes.has_key?(:'limit_bandwidth_unit')
    self.limit_bandwidth_unit = attributes[:'limit_bandwidth_unit']
  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?(:'scheduled_reset_at')
    self.scheduled_reset_at = attributes[:'scheduled_reset_at']
  end

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

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

Instance Attribute Details

#eula_required ⇒ Object

If checked, a EULA acceptance is required for this token.



18
19
20
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 18

def eula_required
  @eula_required
end

#is_active ⇒ Object

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



21
22
23
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 21

def is_active
  @is_active
end

#limit_bandwidth ⇒ Object

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



24
25
26
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 24

def limit_bandwidth
  @limit_bandwidth
end

#limit_bandwidth_unit ⇒ Object

None



27
28
29
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 27

def limit_bandwidth_unit
  @limit_bandwidth_unit
end

#limit_date_range_from ⇒ Object

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



30
31
32
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 30

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.



33
34
35
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 33

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.



36
37
38
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 36

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.



39
40
41
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 39

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.



42
43
44
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 42

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.



45
46
47
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 45

def limit_path_query
  @limit_path_query
end

#metadata ⇒ Object

None



48
49
50
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 48

def metadata
  @metadata
end

#name ⇒ Object

None



51
52
53
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 51

def name
  @name
end

#scheduled_reset_at ⇒ Object

The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero.



54
55
56
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 54

def scheduled_reset_at
  @scheduled_reset_at
end

#scheduled_reset_period ⇒ Object

None



57
58
59
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 57

def scheduled_reset_period
  @scheduled_reset_period
end

#token ⇒ Object

None



60
61
62
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 60

def token
  @token
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 63

def self.attribute_map
  {
    :'eula_required' => :'eula_required',
    :'is_active' => :'is_active',
    :'limit_bandwidth' => :'limit_bandwidth',
    :'limit_bandwidth_unit' => :'limit_bandwidth_unit',
    :'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',
    :'scheduled_reset_at' => :'scheduled_reset_at',
    :'scheduled_reset_period' => :'scheduled_reset_period',
    :'token' => :'token'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'eula_required' => :'BOOLEAN',
    :'is_active' => :'BOOLEAN',
    :'limit_bandwidth' => :'Integer',
    :'limit_bandwidth_unit' => :'String',
    :'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',
    :'scheduled_reset_at' => :'String',
    :'scheduled_reset_period' => :'String',
    :'token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      eula_required == o.eula_required &&
      is_active == o.is_active &&
      limit_bandwidth == o.limit_bandwidth &&
      limit_bandwidth_unit == o.limit_bandwidth_unit &&
      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 &&
      scheduled_reset_at == o.scheduled_reset_at &&
      scheduled_reset_period == o.scheduled_reset_period &&
      token == o.token
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



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

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 315

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 228

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


215
216
217
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 221

def hash
  [eula_required, is_active, limit_bandwidth, limit_bandwidth_unit, limit_date_range_from, limit_date_range_to, limit_num_clients, limit_num_downloads, limit_package_query, limit_path_query, metadata, name, scheduled_reset_at, scheduled_reset_period, 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



175
176
177
178
179
180
181
182
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 175

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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 295

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



301
302
303
304
305
306
307
308
309
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 301

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



289
290
291
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 289

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



186
187
188
189
 
# File 'lib/cloudsmith-api/models/entitlements_create.rb', line 186

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