Class: SwaggerClient::ConfigurationsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor_swagger_client/models/configurations_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfigurationsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
292
293
294
295
296
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 175

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']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_mode ⇒ Object

The auth mode of current system, such as "db_auth", "ldap_auth"



18
19
20
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 18

def auth_mode
  @auth_mode
end

#count_per_project ⇒ Object

The default count quota for the new created projects.



21
22
23
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 21

def count_per_project
  @count_per_project
end

#email_from ⇒ Object

The sender name for Email notification.



24
25
26
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 24

def email_from
  @email_from
end

#email_host ⇒ Object

The hostname of SMTP server that sends Email notification.



27
28
29
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 27

def email_host
  @email_host
end

#email_identity ⇒ Object

By default it’s empty so the email_username is picked.



33
34
35
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 33

def email_identity
  @email_identity
end

#email_insecure ⇒ Object

Whether or not the certificate will be verified when Harbor tries to access the email server.



42
43
44
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 42

def email_insecure
  @email_insecure
end

#email_port ⇒ Object

The port of SMTP server.



30
31
32
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 30

def email_port
  @email_port
end

#email_ssl ⇒ Object

When it’s set to true the system will access Email server via TLS by default. If it’s set to false, it still will handle "STARTTLS" from server side.



39
40
41
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 39

def email_ssl
  @email_ssl
end

#email_username ⇒ Object

The username for authenticate against SMTP server.



36
37
38
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 36

def email_username
  @email_username
end

#ldap_base_dn ⇒ Object

The Base DN for LDAP binding.



48
49
50
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 48

def ldap_base_dn
  @ldap_base_dn
end

#ldap_filter ⇒ Object

The filter for LDAP binding.



51
52
53
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 51

def ldap_filter
  @ldap_filter
end

#ldap_group_admin_dn ⇒ Object

Specify the ldap group which have the same privilege with Harbor admin.



78
79
80
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 78

def ldap_group_admin_dn
  @ldap_group_admin_dn
end

#ldap_group_attribute_name ⇒ Object

The attribute which is used as identity of the LDAP group, default is cn.



66
67
68
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 66

def ldap_group_attribute_name
  @ldap_group_attribute_name
end

#ldap_group_base_dn ⇒ Object

The base DN to search LDAP group.



69
70
71
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 69

def ldap_group_base_dn
  @ldap_group_base_dn
end

#ldap_group_search_filter ⇒ Object

The filter to search the ldap group.



72
73
74
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 72

def ldap_group_search_filter
  @ldap_group_search_filter
end

#ldap_group_search_scope ⇒ Object

The scope to search ldap. ‘0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE’



75
76
77
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 75

def ldap_group_search_scope
  @ldap_group_search_scope
end

#ldap_scope ⇒ Object

0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE



54
55
56
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 54

def ldap_scope
  @ldap_scope
end

#ldap_search_dn ⇒ Object

The DN of the user to do the search.



60
61
62
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 60

def ldap_search_dn
  @ldap_search_dn
end

#ldap_timeout ⇒ Object

timeout in seconds for connection to LDAP server.



63
64
65
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 63

def ldap_timeout
  @ldap_timeout
end

#ldap_uid ⇒ Object

The attribute which is used as identity for the LDAP binding, such as "CN" or "SAMAccountname"



57
58
59
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 57

def ldap_uid
  @ldap_uid
end

#ldap_url ⇒ Object

The URL of LDAP server.



45
46
47
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 45

def ldap_url
  @ldap_url
end

#project_creation_restriction ⇒ Object

This attribute restricts what users have the permission to create project. It can be "everyone" or "adminonly".



81
82
83
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 81

def project_creation_restriction
  @project_creation_restriction
end

#quota_per_project_enable ⇒ Object

This attribute indicates whether quota per project enabled in harbor



84
85
86
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 84

def quota_per_project_enable
  @quota_per_project_enable
end

#read_only ⇒ Object

‘docker push’ is prohibited by Harbor if you set it to true.



87
88
89
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 87

def read_only
  @read_only
end

#scan_all_policy ⇒ Object

Returns the value of attribute scan_all_policy.



101
102
103
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 101

def scan_all_policy
  @scan_all_policy
end

#self_registration ⇒ Object

Whether the Harbor instance supports self-registration. If it’s set to false, admin need to add user to the instance.



90
91
92
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 90

def self_registration
  @self_registration
end

#storage_per_project ⇒ Object

The default storage quota for the new created projects.



93
94
95
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 93

def storage_per_project
  @storage_per_project
end

#token_expiration ⇒ Object

The expiration time of the token for internal Registry, in minutes.



96
97
98
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 96

def token_expiration
  @token_expiration
end

#verify_remote_cert ⇒ Object

Whether or not the certificate will be verified when Harbor tries to access a remote Harbor instance for replication.



99
100
101
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 99

def verify_remote_cert
  @verify_remote_cert
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
136
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 104

def self.attribute_map
  {
    :'auth_mode' => :'auth_mode',
    :'count_per_project' => :'count_per_project',
    :'email_from' => :'email_from',
    :'email_host' => :'email_host',
    :'email_port' => :'email_port',
    :'email_identity' => :'email_identity',
    :'email_username' => :'email_username',
    :'email_ssl' => :'email_ssl',
    :'email_insecure' => :'email_insecure',
    :'ldap_url' => :'ldap_url',
    :'ldap_base_dn' => :'ldap_base_dn',
    :'ldap_filter' => :'ldap_filter',
    :'ldap_scope' => :'ldap_scope',
    :'ldap_uid' => :'ldap_uid',
    :'ldap_search_dn' => :'ldap_search_dn',
    :'ldap_timeout' => :'ldap_timeout',
    :'ldap_group_attribute_name' => :'ldap_group_attribute_name',
    :'ldap_group_base_dn' => :'ldap_group_base_dn',
    :'ldap_group_search_filter' => :'ldap_group_search_filter',
    :'ldap_group_search_scope' => :'ldap_group_search_scope',
    :'ldap_group_admin_dn' => :'ldap_group_admin_dn',
    :'project_creation_restriction' => :'project_creation_restriction',
    :'quota_per_project_enable' => :'quota_per_project_enable',
    :'read_only' => :'read_only',
    :'self_registration' => :'self_registration',
    :'storage_per_project' => :'storage_per_project',
    :'token_expiration' => :'token_expiration',
    :'verify_remote_cert' => :'verify_remote_cert',
    :'scan_all_policy' => :'scan_all_policy'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/harbor_swagger_client/models/configurations_response.rb', line 139

def self.swagger_types
  {
    :'auth_mode' => :'StringConfigItem',
    :'count_per_project' => :'IntegerConfigItem',
    :'email_from' => :'StringConfigItem',
    :'email_host' => :'StringConfigItem',
    :'email_port' => :'IntegerConfigItem',
    :'email_identity' => :'StringConfigItem',
    :'email_username' => :'StringConfigItem',
    :'email_ssl' => :'BoolConfigItem',
    :'email_insecure' => :'BoolConfigItem',
    :'ldap_url' => :'StringConfigItem',
    :'ldap_base_dn' => :'StringConfigItem',
    :'ldap_filter' => :'StringConfigItem',
    :'ldap_scope' => :'IntegerConfigItem',
    :'ldap_uid' => :'StringConfigItem',
    :'ldap_search_dn' => :'StringConfigItem',
    :'ldap_timeout' => :'IntegerConfigItem',
    :'ldap_group_attribute_name' => :'StringConfigItem',
    :'ldap_group_base_dn' => :'StringConfigItem',
    :'ldap_group_search_filter' => :'StringConfigItem',
    :'ldap_group_search_scope' => :'IntegerConfigItem',
    :'ldap_group_admin_dn' => :'StringConfigItem',
    :'project_creation_restriction' => :'StringConfigItem',
    :'quota_per_project_enable' => :'BoolConfigItem',
    :'read_only' => :'BoolConfigItem',
    :'self_registration' => :'BoolConfigItem',
    :'storage_per_project' => :'IntegerConfigItem',
    :'token_expiration' => :'IntegerConfigItem',
    :'verify_remote_cert' => :'BoolConfigItem',
    :'scan_all_policy' => :'ConfigurationsScanAllPolicy'
  }
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
345
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_mode == o.auth_mode &&
      count_per_project == o.count_per_project &&
      email_from == o.email_from &&
      email_host == o.email_host &&
      email_port == o.email_port &&
      email_identity == o.email_identity &&
      email_username == o.email_username &&
      email_ssl == o.email_ssl &&
      email_insecure == o.email_insecure &&
      ldap_url == o.ldap_url &&
      ldap_base_dn == o.ldap_base_dn &&
      ldap_filter == o.ldap_filter &&
      ldap_scope == o.ldap_scope &&
      ldap_uid == o.ldap_uid &&
      ldap_search_dn == o.ldap_search_dn &&
      ldap_timeout == o.ldap_timeout &&
      ldap_group_attribute_name == o.ldap_group_attribute_name &&
      ldap_group_base_dn == o.ldap_group_base_dn &&
      ldap_group_search_filter == o.ldap_group_search_filter &&
      ldap_group_search_scope == o.ldap_group_search_scope &&
      ldap_group_admin_dn == o.ldap_group_admin_dn &&
      project_creation_restriction == o.project_creation_restriction &&
      quota_per_project_enable == o.quota_per_project_enable &&
      read_only == o.read_only &&
      self_registration == o.self_registration &&
      storage_per_project == o.storage_per_project &&
      token_expiration == o.token_expiration &&
      verify_remote_cert == o.verify_remote_cert &&
      scan_all_policy == o.scan_all_policy
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



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
419
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 383

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 = SwaggerClient.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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 449

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 362

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


349
350
351
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 349

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



355
356
357
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 355

def hash
  [auth_mode, count_per_project, email_from, email_host, email_port, email_identity, email_username, email_ssl, email_insecure, ldap_url, ldap_base_dn, ldap_filter, ldap_scope, ldap_uid, ldap_search_dn, ldap_timeout, ldap_group_attribute_name, ldap_group_base_dn, ldap_group_search_filter, ldap_group_search_scope, ldap_group_admin_dn, project_creation_restriction, quota_per_project_enable, read_only, self_registration, storage_per_project, token_expiration, verify_remote_cert, scan_all_policy].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



300
301
302
303
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 300

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



429
430
431
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 429

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



435
436
437
438
439
440
441
442
443
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 435

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



423
424
425
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 423

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



307
308
309
 
# File 'lib/harbor_swagger_client/models/configurations_response.rb', line 307

def valid?
  true
end