Class: Harbor2Client::ScannerRegistration

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_client/models/scanner_registration.rb

Overview

Registration represents a named configuration for invoking a scanner via its adapter.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScannerRegistration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
192
193
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 112

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

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

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

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

  if attributes.has_key?(:'disabled')
    self.disabled = attributes[:'disabled']
  else
    self.disabled = false
  end

  if attributes.has_key?(:'is_default')
    self.is_default = attributes[:'is_default']
  else
    self.is_default = false
  end

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

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

  if attributes.has_key?(:'skip_certVerify')
    self.skip_cert_verify = attributes[:'skip_certVerify']
  else
    self.skip_cert_verify = false
  end

  if attributes.has_key?(:'use_internal_addr')
    self.use_internal_addr = attributes[:'use_internal_addr']
  else
    self.use_internal_addr = false
  end

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

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

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

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

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

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

Instance Attribute Details

#access_credential ⇒ Object

An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.



40
41
42
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 40

def access_credential
  @access_credential
end

#adapter ⇒ Object

Optional property to describe the name of the scanner registration



55
56
57
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 55

def adapter
  @adapter
end

#auth ⇒ Object

Specify what authentication approach is adopted for the HTTP communications. Supported types Basic", "Bearer" and api key header "X-ScannerAdapter-API-Key"



37
38
39
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 37

def auth
  @auth
end

#create_time ⇒ Object

The creation time of this registration



49
50
51
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 49

def create_time
  @create_time
end

#description ⇒ Object

An optional description of this registration.



25
26
27
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 25

def description
  @description
end

#disabled ⇒ Object

Indicate whether the registration is enabled or not



31
32
33
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 31

def disabled
  @disabled
end

#health ⇒ Object

Indicate the healthy of the registration



64
65
66
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 64

def health
  @health
end

#is_default ⇒ Object

Indicate if the registration is set as the system default one



34
35
36
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 34

def is_default
  @is_default
end

#name ⇒ Object

The name of this registration.



22
23
24
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 22

def name
  @name
end

#skip_cert_verify ⇒ Object

Indicate if skip the certificate verification when sending HTTP requests



43
44
45
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 43

def skip_cert_verify
  @skip_cert_verify
end

#update_time ⇒ Object

The update time of this registration



52
53
54
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 52

def update_time
  @update_time
end

#url ⇒ Object

A base URL of the scanner adapter



28
29
30
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 28

def url
  @url
end

#use_internal_addr ⇒ Object

Indicate whether use internal registry addr for the scanner to pull content or not



46
47
48
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 46

def use_internal_addr
  @use_internal_addr
end

#uuid ⇒ Object

The unique identifier of this registration.



19
20
21
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 19

def uuid
  @uuid
end

#vendor ⇒ Object

Optional property to describe the vendor of the scanner registration



58
59
60
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 58

def vendor
  @vendor
end

#version ⇒ Object

Optional property to describe the version of the scanner registration



61
62
63
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 61

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 67

def self.attribute_map
  {
    :'uuid' => :'uuid',
    :'name' => :'name',
    :'description' => :'description',
    :'url' => :'url',
    :'disabled' => :'disabled',
    :'is_default' => :'is_default',
    :'auth' => :'auth',
    :'access_credential' => :'access_credential',
    :'skip_cert_verify' => :'skip_certVerify',
    :'use_internal_addr' => :'use_internal_addr',
    :'create_time' => :'create_time',
    :'update_time' => :'update_time',
    :'adapter' => :'adapter',
    :'vendor' => :'vendor',
    :'version' => :'version',
    :'health' => :'health'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 89

def self.swagger_types
  {
    :'uuid' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'url' => :'String',
    :'disabled' => :'BOOLEAN',
    :'is_default' => :'BOOLEAN',
    :'auth' => :'String',
    :'access_credential' => :'String',
    :'skip_cert_verify' => :'BOOLEAN',
    :'use_internal_addr' => :'BOOLEAN',
    :'create_time' => :'DateTime',
    :'update_time' => :'DateTime',
    :'adapter' => :'String',
    :'vendor' => :'String',
    :'version' => :'String',
    :'health' => :'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
228
229
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uuid == o.uuid &&
      name == o.name &&
      description == o.description &&
      url == o.url &&
      disabled == o.disabled &&
      is_default == o.is_default &&
      auth == o.auth &&
      access_credential == o.access_credential &&
      skip_cert_verify == o.skip_cert_verify &&
      use_internal_addr == o.use_internal_addr &&
      create_time == o.create_time &&
      update_time == o.update_time &&
      adapter == o.adapter &&
      vendor == o.vendor &&
      version == o.version &&
      health == o.health
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



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
297
298
299
300
301
302
303
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 267

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 333

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 246

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


233
234
235
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 239

def hash
  [uuid, name, description, url, disabled, is_default, auth, access_credential, skip_cert_verify, use_internal_addr, create_time, update_time, adapter, vendor, version, health].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



197
198
199
200
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 197

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



313
314
315
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 313

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



319
320
321
322
323
324
325
326
327
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 319

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



307
308
309
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 307

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



204
205
206
 
# File 'lib/harbor2_client/models/scanner_registration.rb', line 204

def valid?
  true
end