Class: CloudsmithApi::GenericUpstream

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenericUpstream

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
292
293
294
295
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 180

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

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

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

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

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

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

  if attributes.has_key?(:'disable_reason')
    self.disable_reason = attributes[:'disable_reason']
  else
    self.disable_reason = 'N/A'
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'mode')
    self.mode = attributes[:'mode']
  else
    self.mode = 'Proxy Only'
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_mode ⇒ Object

The authentication mode to use when accessing this upstream.



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

def auth_mode
  @auth_mode
end

#auth_secret ⇒ Object

Secret to provide with requests to upstream.



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

def auth_secret
  @auth_secret
end

#auth_username ⇒ Object

Username to provide with requests to upstream.



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

def auth_username
  @auth_username
end

#available ⇒ Object

Whether the upstream is available for use.



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

def available
  @available
end

#can_reindex ⇒ Object

Whether the upstream can be reindexed.



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

def can_reindex
  @can_reindex
end

#created_at ⇒ Object

The datetime the upstream source was created.



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

def created_at
  @created_at
end

#disable_reason ⇒ Object

Returns the value of attribute disable_reason.



35
36
37
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 35

def disable_reason
  @disable_reason
end

#disable_reason_text ⇒ Object

Human-readable explanation of why this upstream is disabled



38
39
40
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 38

def disable_reason_text
  @disable_reason_text
end

#extra_header_1 ⇒ Object

The key for extra header #1 to send to upstream.



41
42
43
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 41

def extra_header_1
  @extra_header_1
end

#extra_header_2 ⇒ Object

The key for extra header #2 to send to upstream.



44
45
46
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 44

def extra_header_2
  @extra_header_2
end

#extra_value_1 ⇒ Object

The value for extra header #1 to send to upstream. This is stored as plaintext, and is NOT encrypted.



47
48
49
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 47

def extra_value_1
  @extra_value_1
end

#extra_value_2 ⇒ Object

The value for extra header #2 to send to upstream. This is stored as plaintext, and is NOT encrypted.



50
51
52
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 50

def extra_value_2
  @extra_value_2
end

#has_failed_signature_verification ⇒ Object

Whether the upstream has failed signature verification.



53
54
55
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 53

def has_failed_signature_verification
  @has_failed_signature_verification
end

#index_package_count ⇒ Object

The number of packages available in this upstream source



56
57
58
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 56

def index_package_count
  @index_package_count
end

#index_status ⇒ Object

The current indexing status of this upstream source



59
60
61
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 59

def index_status
  @index_status
end

#is_active ⇒ Object

Whether or not this upstream is active and ready for requests.



62
63
64
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 62

def is_active
  @is_active
end

#last_indexed ⇒ Object

The last time this upstream source was indexed



65
66
67
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 65

def last_indexed
  @last_indexed
end

#mode ⇒ Object

The mode that this upstream should operate in. Upstream sources can be used to proxy resolved packages, as well as operate in a proxy/cache or cache only mode.



68
69
70
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 68

def mode
  @mode
end

#name ⇒ Object

A descriptive name for this upstream source. A shortened version of this name will be used for tagging cached packages retrieved from this upstream.



71
72
73
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 71

def name
  @name
end

#pending_validation ⇒ Object

When true, this upstream source is pending validation.



74
75
76
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 74

def pending_validation
  @pending_validation
end

#priority ⇒ Object

Upstream sources are selected for resolving requests by sequential order (1..n), followed by creation date.



77
78
79
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 77

def priority
  @priority
end

#slug_perm ⇒ Object

Returns the value of attribute slug_perm.



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

def slug_perm
  @slug_perm
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



81
82
83
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 81

def updated_at
  @updated_at
end

#upstream_prefix ⇒ Object

A unique prefix used to distinguish this upstream source within the repository. Generic upstreams can represent entirely different file servers, and we do not attempt to blend them. The prefix ensures each source remains separate, and requests including this prefix are routed to the correct upstream.



84
85
86
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 84

def upstream_prefix
  @upstream_prefix
end

#upstream_url ⇒ Object

The URL for this upstream source. This must be a fully qualified URL including any path elements required to reach the root of the repository.



87
88
89
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 87

def upstream_url
  @upstream_url
end

#verify_ssl ⇒ Object

If enabled, SSL certificates are verified when requests are made to this upstream. It’s recommended to leave this enabled for all public sources to help mitigate Man-In-The-Middle (MITM) attacks. Please note this only applies to HTTPS upstreams.



90
91
92
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 90

def verify_ssl
  @verify_ssl
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'auth_mode' => :'auth_mode',
    :'auth_secret' => :'auth_secret',
    :'auth_username' => :'auth_username',
    :'available' => :'available',
    :'can_reindex' => :'can_reindex',
    :'created_at' => :'created_at',
    :'disable_reason' => :'disable_reason',
    :'disable_reason_text' => :'disable_reason_text',
    :'extra_header_1' => :'extra_header_1',
    :'extra_header_2' => :'extra_header_2',
    :'extra_value_1' => :'extra_value_1',
    :'extra_value_2' => :'extra_value_2',
    :'has_failed_signature_verification' => :'has_failed_signature_verification',
    :'index_package_count' => :'index_package_count',
    :'index_status' => :'index_status',
    :'is_active' => :'is_active',
    :'last_indexed' => :'last_indexed',
    :'mode' => :'mode',
    :'name' => :'name',
    :'pending_validation' => :'pending_validation',
    :'priority' => :'priority',
    :'slug_perm' => :'slug_perm',
    :'updated_at' => :'updated_at',
    :'upstream_prefix' => :'upstream_prefix',
    :'upstream_url' => :'upstream_url',
    :'verify_ssl' => :'verify_ssl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'auth_mode' => :'String',
    :'auth_secret' => :'String',
    :'auth_username' => :'String',
    :'available' => :'BOOLEAN',
    :'can_reindex' => :'BOOLEAN',
    :'created_at' => :'DateTime',
    :'disable_reason' => :'String',
    :'disable_reason_text' => :'String',
    :'extra_header_1' => :'String',
    :'extra_header_2' => :'String',
    :'extra_value_1' => :'String',
    :'extra_value_2' => :'String',
    :'has_failed_signature_verification' => :'BOOLEAN',
    :'index_package_count' => :'Integer',
    :'index_status' => :'String',
    :'is_active' => :'BOOLEAN',
    :'last_indexed' => :'String',
    :'mode' => :'String',
    :'name' => :'String',
    :'pending_validation' => :'BOOLEAN',
    :'priority' => :'Integer',
    :'slug_perm' => :'String',
    :'updated_at' => :'DateTime',
    :'upstream_prefix' => :'String',
    :'upstream_url' => :'String',
    :'verify_ssl' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 358

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_mode == o.auth_mode &&
      auth_secret == o.auth_secret &&
      auth_username == o.auth_username &&
      available == o.available &&
      can_reindex == o.can_reindex &&
      created_at == o.created_at &&
      disable_reason == o.disable_reason &&
      disable_reason_text == o.disable_reason_text &&
      extra_header_1 == o.extra_header_1 &&
      extra_header_2 == o.extra_header_2 &&
      extra_value_1 == o.extra_value_1 &&
      extra_value_2 == o.extra_value_2 &&
      has_failed_signature_verification == o.has_failed_signature_verification &&
      index_package_count == o.index_package_count &&
      index_status == o.index_status &&
      is_active == o.is_active &&
      last_indexed == o.last_indexed &&
      mode == o.mode &&
      name == o.name &&
      pending_validation == o.pending_validation &&
      priority == o.priority &&
      slug_perm == o.slug_perm &&
      updated_at == o.updated_at &&
      upstream_prefix == o.upstream_prefix &&
      upstream_url == o.upstream_url &&
      verify_ssl == o.verify_ssl
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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 425

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



491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 491

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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 404

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


391
392
393
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 391

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



397
398
399
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 397

def hash
  [auth_mode, auth_secret, auth_username, available, can_reindex, created_at, disable_reason, disable_reason_text, extra_header_1, extra_header_2, extra_value_1, extra_value_2, has_failed_signature_verification, index_package_count, index_status, is_active, last_indexed, mode, name, pending_validation, priority, slug_perm, updated_at, upstream_prefix, upstream_url, verify_ssl].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



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

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

  if @upstream_url.nil?
    invalid_properties.push('invalid value for "upstream_url", upstream_url 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



471
472
473
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 471

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



477
478
479
480
481
482
483
484
485
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 477

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



465
466
467
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 465

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



314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/cloudsmith-api/models/generic_upstream.rb', line 314

def valid?
  auth_mode_validator = EnumAttributeValidator.new('String', ['None', 'Username and Password', 'Token'])
  return false unless auth_mode_validator.valid?(@auth_mode)
  disable_reason_validator = EnumAttributeValidator.new('String', ['N/A', 'Upstream points to its own repository', 'Missing upstream source', 'Upstream was disabled by request of user'])
  return false unless disable_reason_validator.valid?(@disable_reason)
  mode_validator = EnumAttributeValidator.new('String', ['Proxy Only', 'Cache and Proxy'])
  return false unless mode_validator.valid?(@mode)
  return false if @name.nil?
  return false if @upstream_url.nil?
  true
end