class Harbor1Client::GeneralInfo

Attributes

admiral_endpoint[RW]

The url of the endpoint of admiral instance.

auth_mode[RW]

The auth mode of current Harbor instance.

clair_vulnerability_status[RW]
external_url[RW]

The external URL of Harbor, with protocol.

harbor_version[RW]

The build version of Harbor.

has_ca_root[RW]

Indicate whether there is a ca root cert file ready for download in the file system.

next_scan_all[RW]

The UTC time in milliseconds, after which user can call scanAll API to scan all images.

project_creation_restriction[RW]

Indicate who can create projects, it could be 'adminonly' or 'everyone'.

registry_url[RW]

The url of registry against which the docker command should be issued.

self_registration[RW]

Indicate whether the Harbor instance enable user to register himself.

with_admiral[RW]

If the Harbor instance is deployed with Admiral.

with_clair[RW]

If the Harbor instance is deployed with nested clair.

with_notary[RW]

If the Harbor instance is deployed with nested notary.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/harbor1_client/models/general_info.rb, line 56
def self.attribute_map
  {
    :'with_notary' => :'with_notary',
    :'with_clair' => :'with_clair',
    :'with_admiral' => :'with_admiral',
    :'admiral_endpoint' => :'admiral_endpoint',
    :'registry_url' => :'registry_url',
    :'external_url' => :'external_url',
    :'auth_mode' => :'auth_mode',
    :'project_creation_restriction' => :'project_creation_restriction',
    :'self_registration' => :'self_registration',
    :'has_ca_root' => :'has_ca_root',
    :'harbor_version' => :'harbor_version',
    :'next_scan_all' => :'next_scan_all',
    :'clair_vulnerability_status' => :'clair_vulnerability_status'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/harbor1_client/models/general_info.rb, line 95
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?(:'with_notary')
    self.with_notary = attributes[:'with_notary']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'clair_vulnerability_status')
    self.clair_vulnerability_status = attributes[:'clair_vulnerability_status']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/harbor1_client/models/general_info.rb, line 75
def self.swagger_types
  {
    :'with_notary' => :'BOOLEAN',
    :'with_clair' => :'BOOLEAN',
    :'with_admiral' => :'BOOLEAN',
    :'admiral_endpoint' => :'String',
    :'registry_url' => :'String',
    :'external_url' => :'String',
    :'auth_mode' => :'String',
    :'project_creation_restriction' => :'String',
    :'self_registration' => :'BOOLEAN',
    :'has_ca_root' => :'BOOLEAN',
    :'harbor_version' => :'String',
    :'next_scan_all' => :'Integer',
    :'clair_vulnerability_status' => :'GeneralInfoClairVulnerabilityStatus'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/harbor1_client/models/general_info.rb, line 169
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      with_notary == o.with_notary &&
      with_clair == o.with_clair &&
      with_admiral == o.with_admiral &&
      admiral_endpoint == o.admiral_endpoint &&
      registry_url == o.registry_url &&
      external_url == o.external_url &&
      auth_mode == o.auth_mode &&
      project_creation_restriction == o.project_creation_restriction &&
      self_registration == o.self_registration &&
      has_ca_root == o.has_ca_root &&
      harbor_version == o.harbor_version &&
      next_scan_all == o.next_scan_all &&
      clair_vulnerability_status == o.clair_vulnerability_status
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/harbor1_client/models/general_info.rb, line 223
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 = Harbor1Client.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/harbor1_client/models/general_info.rb, line 289
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/harbor1_client/models/general_info.rb, line 202
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/harbor1_client/models/general_info.rb, line 189
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/harbor1_client/models/general_info.rb, line 195
def hash
  [with_notary, with_clair, with_admiral, admiral_endpoint, registry_url, external_url, auth_mode, project_creation_restriction, self_registration, has_ca_root, harbor_version, next_scan_all, clair_vulnerability_status].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/harbor1_client/models/general_info.rb, line 156
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/harbor1_client/models/general_info.rb, line 269
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/harbor1_client/models/general_info.rb, line 275
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/harbor1_client/models/general_info.rb, line 263
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/harbor1_client/models/general_info.rb, line 163
def valid?
  true
end