class Zest::FileRemote

Attributes

_created[RW]

Timestamp of creation.

_href[RW]
_last_updated[RW]

Timestamp of the most recent update of the remote.

_type[RW]
download_concurrency[RW]

Total number of simultaneous connections.

name[RW]

A unique name for this remote.

password[RW]

The password to be used for authentication when syncing.

policy[RW]

The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default.

proxy_url[RW]

The proxy URL. Format: scheme://user:password@host:port

ssl_ca_certificate[RW]

A PEM encoded CA certificate used to validate the server certificate presented by the remote server.

ssl_client_certificate[RW]

A PEM encoded client certificate used for authentication.

ssl_client_key[RW]

A PEM encoded private key used for authentication.

ssl_validation[RW]

If True, SSL peer validation must be performed.

url[RW]

The URL of an external content source.

username[RW]

The username to be used for authentication when syncing.

validate[RW]

If True, the plugin will validate imported artifacts.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/zest/models/file_remote.rb, line 87
def self.attribute_map
  {
    :'_href' => :'_href',
    :'_created' => :'_created',
    :'_type' => :'_type',
    :'name' => :'name',
    :'url' => :'url',
    :'validate' => :'validate',
    :'ssl_ca_certificate' => :'ssl_ca_certificate',
    :'ssl_client_certificate' => :'ssl_client_certificate',
    :'ssl_client_key' => :'ssl_client_key',
    :'ssl_validation' => :'ssl_validation',
    :'proxy_url' => :'proxy_url',
    :'username' => :'username',
    :'password' => :'password',
    :'_last_updated' => :'_last_updated',
    :'download_concurrency' => :'download_concurrency',
    :'policy' => :'policy'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/zest/models/file_remote.rb, line 132
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?(:'_href')
    self._href = attributes[:'_href']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'policy')
    self.policy = attributes[:'policy']
  else
    self.policy = "immediate"
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/zest/models/file_remote.rb, line 109
def self.swagger_types
  {
    :'_href' => :'String',
    :'_created' => :'DateTime',
    :'_type' => :'String',
    :'name' => :'String',
    :'url' => :'String',
    :'validate' => :'BOOLEAN',
    :'ssl_ca_certificate' => :'String',
    :'ssl_client_certificate' => :'String',
    :'ssl_client_key' => :'String',
    :'ssl_validation' => :'BOOLEAN',
    :'proxy_url' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'_last_updated' => :'DateTime',
    :'download_concurrency' => :'Integer',
    :'policy' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/zest/models/file_remote.rb, line 313
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _href == o._href &&
      _created == o._created &&
      _type == o._type &&
      name == o.name &&
      url == o.url &&
      validate == o.validate &&
      ssl_ca_certificate == o.ssl_ca_certificate &&
      ssl_client_certificate == o.ssl_client_certificate &&
      ssl_client_key == o.ssl_client_key &&
      ssl_validation == o.ssl_validation &&
      proxy_url == o.proxy_url &&
      username == o.username &&
      password == o.password &&
      _last_updated == o._last_updated &&
      download_concurrency == o.download_concurrency &&
      policy == o.policy
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/zest/models/file_remote.rb, line 370
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 = Zest.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/zest/models/file_remote.rb, line 436
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
_type=(_type) click to toggle source

Custom attribute writer method with validation @param [Object] _type Value to be assigned

# File lib/zest/models/file_remote.rb, line 253
def _type=(_type)

  if !_type.nil? && _type.to_s.length < 1
    fail ArgumentError, "invalid value for '_type', the character length must be great than or equal to 1."
  end

  @_type = _type
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/zest/models/file_remote.rb, line 349
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
download_concurrency=(download_concurrency) click to toggle source

Custom attribute writer method with validation @param [Object] download_concurrency Value to be assigned

# File lib/zest/models/file_remote.rb, line 292
def download_concurrency=(download_concurrency)

  if !download_concurrency.nil? && download_concurrency < 1
    fail ArgumentError, "invalid value for 'download_concurrency', must be greater than or equal to 1."
  end

  @download_concurrency = download_concurrency
end
eql?(o) click to toggle source

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

# File lib/zest/models/file_remote.rb, line 336
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/zest/models/file_remote.rb, line 342
def hash
  [_href, _created, _type, name, url, validate, ssl_ca_certificate, ssl_client_certificate, ssl_client_key, ssl_validation, proxy_url, username, password, _last_updated, download_concurrency, policy].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/zest/models/file_remote.rb, line 208
def list_invalid_properties
  invalid_properties = Array.new
  if !@_type.nil? && @_type.to_s.length < 1
    invalid_properties.push("invalid value for '_type', the character length must be great than or equal to 1.")
  end

  if @name.nil?
    invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end

  if @name.to_s.length < 1
    invalid_properties.push("invalid value for 'name', the character length must be great than or equal to 1.")
  end

  if @url.nil?
    invalid_properties.push("invalid value for 'url', url cannot be nil.")
  end

  if @url.to_s.length < 1
    invalid_properties.push("invalid value for 'url', the character length must be great than or equal to 1.")
  end

  if !@download_concurrency.nil? && @download_concurrency < 1
    invalid_properties.push("invalid value for 'download_concurrency', must be greater than or equal to 1.")
  end

  return invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/zest/models/file_remote.rb, line 264
def name=(name)
  if name.nil?
    fail ArgumentError, "name cannot be nil"
  end

  if name.to_s.length < 1
    fail ArgumentError, "invalid value for 'name', the character length must be great than or equal to 1."
  end

  @name = name
end
policy=(policy) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] policy Object to be assigned

# File lib/zest/models/file_remote.rb, line 303
def policy=(policy)
  validator = EnumAttributeValidator.new('String', ["immediate", "on_demand", "streamed"])
  unless validator.valid?(policy)
    fail ArgumentError, "invalid value for 'policy', must be one of #{validator.allowable_values}."
  end
  @policy = policy
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/zest/models/file_remote.rb, line 416
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/zest/models/file_remote.rb, line 422
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/zest/models/file_remote.rb, line 410
def to_s
  to_hash.to_s
end
url=(url) click to toggle source

Custom attribute writer method with validation @param [Object] url Value to be assigned

# File lib/zest/models/file_remote.rb, line 278
def url=(url)
  if url.nil?
    fail ArgumentError, "url cannot be nil"
  end

  if url.to_s.length < 1
    fail ArgumentError, "invalid value for 'url', the character length must be great than or equal to 1."
  end

  @url = url
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/zest/models/file_remote.rb, line 239
def valid?
  return false if !@_type.nil? && @_type.to_s.length < 1
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @url.nil?
  return false if @url.to_s.length < 1
  return false if !@download_concurrency.nil? && @download_concurrency < 1
  policy_validator = EnumAttributeValidator.new('String', ["immediate", "on_demand", "streamed"])
  return false unless policy_validator.valid?(@policy)
  return true
end