class Fastly::DirectorResponse

Attributes

backends[RW]

List of backends associated to a director.

capacity[RW]

Unused.

comment[RW]

A freeform descriptive note.

created_at[RW]

Date and time in ISO 8601 format.

deleted_at[RW]

Date and time in ISO 8601 format.

name[RW]

Name for the Director.

quorum[RW]

The percentage of capacity that needs to be up for a director to be considered up. ‘0` to `100`.

retries[RW]

How many backends to search if it fails.

service_id[RW]
shield[RW]

Selected POP to serve as a shield for the backends. Defaults to ‘null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding.

type[RW]

What type of load balance group to use.

updated_at[RW]

Date and time in ISO 8601 format.

version[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/director_response.rb, line 95
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/fastly/models/director_response.rb, line 76
def self.attribute_map
  {
    :'backends' => :'backends',
    :'capacity' => :'capacity',
    :'comment' => :'comment',
    :'name' => :'name',
    :'quorum' => :'quorum',
    :'shield' => :'shield',
    :'type' => :'type',
    :'retries' => :'retries',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at'
  }
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/fastly/models/director_response.rb, line 300
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/fastly/models/director_response.rb, line 130
def self.fastly_all_of
  [
  :'Director',
  :'ServiceIdAndVersion',
  :'Timestamps'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/director_response.rb, line 119
def self.fastly_nullable
  Set.new([
    :'comment',
    :'shield',
    :'created_at',
    :'deleted_at',
    :'updated_at'
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/director_response.rb, line 100
def self.fastly_types
  {
    :'backends' => :'Array<Backend>',
    :'capacity' => :'Integer',
    :'comment' => :'String',
    :'name' => :'String',
    :'quorum' => :'Integer',
    :'shield' => :'String',
    :'type' => :'Integer',
    :'retries' => :'Integer',
    :'service_id' => :'String',
    :'version' => :'Integer',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/fastly/models/director_response.rb, line 140
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::DirectorResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::DirectorResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'backends')
    if (value = attributes[:'backends']).is_a?(Array)
      self.backends = value
    end
  end

  if attributes.key?(:'capacity')
    self.capacity = attributes[:'capacity']
  end

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  end

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

  if attributes.key?(:'quorum')
    self.quorum = attributes[:'quorum']
  else
    self.quorum = 75
  end

  if attributes.key?(:'shield')
    self.shield = attributes[:'shield']
  else
    self.shield = 'null'
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = TYPE::random
  end

  if attributes.key?(:'retries')
    self.retries = attributes[:'retries']
  else
    self.retries = 5
  end

  if attributes.key?(:'service_id')
    self.service_id = attributes[:'service_id']
  end

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

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

  if attributes.key?(:'deleted_at')
    self.deleted_at = attributes[:'deleted_at']
  end

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

Public Instance Methods

==(o) click to toggle source

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

# File lib/fastly/models/director_response.rb, line 267
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      backends == o.backends &&
      capacity == o.capacity &&
      comment == o.comment &&
      name == o.name &&
      quorum == o.quorum &&
      shield == o.shield &&
      type == o.type &&
      retries == o.retries &&
      service_id == o.service_id &&
      version == o.version &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at
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/fastly/models/director_response.rb, line 330
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.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/fastly/models/director_response.rb, line 401
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/fastly/models/director_response.rb, line 307
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end
eql?(o) click to toggle source

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

# File lib/fastly/models/director_response.rb, line 287
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/fastly/models/director_response.rb, line 293
def hash
  [backends, capacity, comment, name, quorum, shield, type, retries, service_id, version, created_at, deleted_at, updated_at].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/fastly/models/director_response.rb, line 218
def list_invalid_properties
  invalid_properties = Array.new
  if !@quorum.nil? && @quorum > 100
    invalid_properties.push('invalid value for "quorum", must be smaller than or equal to 100.')
  end

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

  invalid_properties
end
quorum=(quorum) click to toggle source

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

# File lib/fastly/models/director_response.rb, line 243
def quorum=(quorum)
  if !quorum.nil? && quorum > 100
    fail ArgumentError, 'invalid value for "quorum", must be smaller than or equal to 100.'
  end

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

  @quorum = quorum
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/fastly/models/director_response.rb, line 377
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/fastly/models/director_response.rb, line 383
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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/fastly/models/director_response.rb, line 371
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/fastly/models/director_response.rb, line 257
def type=(type)
  validator = EnumAttributeValidator.new('Integer', [1, 3, 4])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
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/fastly/models/director_response.rb, line 233
def valid?
  return false if !@quorum.nil? && @quorum > 100
  return false if !@quorum.nil? && @quorum < 0
  type_validator = EnumAttributeValidator.new('Integer', [1, 3, 4])
  return false unless type_validator.valid?(@type)
  true
end