class Fastly::HealthcheckResponse

Attributes

check_interval[RW]

How often to run the health check in milliseconds.

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.

expected_response[RW]

The status code expected from the host.

headers[RW]

Array of custom headers that will be added to the health check probes.

host[RW]

Which host to check.

http_version[RW]

Whether to use version 1.0 or 1.1 HTTP.

initial[RW]

When loading a config, the initial number of probes to be seen as OK.

method[RW]

Which HTTP method to use.

name[RW]

The name of the health check.

path[RW]

The path to check.

service_id[RW]
threshold[RW]

How many health checks must succeed to be considered healthy.

timeout[RW]

Timeout in milliseconds.

updated_at[RW]

Date and time in ISO 8601 format.

version[RW]
window[RW]

The number of most recent health check queries to keep for this health check.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/healthcheck_response.rb, line 93
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/healthcheck_response.rb, line 69
def self.attribute_map
  {
    :'check_interval' => :'check_interval',
    :'comment' => :'comment',
    :'expected_response' => :'expected_response',
    :'headers' => :'headers',
    :'host' => :'host',
    :'http_version' => :'http_version',
    :'initial' => :'initial',
    :'method' => :'method',
    :'name' => :'name',
    :'path' => :'path',
    :'threshold' => :'threshold',
    :'timeout' => :'timeout',
    :'window' => :'window',
    :'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/healthcheck_response.rb, line 283
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/healthcheck_response.rb, line 132
def self.fastly_all_of
  [
  :'Healthcheck',
  :'ServiceIdAndVersion',
  :'Timestamps'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/fastly/models/healthcheck_response.rb, line 98
def self.fastly_types
  {
    :'check_interval' => :'Integer',
    :'comment' => :'String',
    :'expected_response' => :'Integer',
    :'headers' => :'Array<String>',
    :'host' => :'String',
    :'http_version' => :'String',
    :'initial' => :'Integer',
    :'method' => :'String',
    :'name' => :'String',
    :'path' => :'String',
    :'threshold' => :'Integer',
    :'timeout' => :'Integer',
    :'window' => :'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/healthcheck_response.rb, line 142
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HealthcheckResponse` 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::HealthcheckResponse`. 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?(:'check_interval')
    self.check_interval = attributes[:'check_interval']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'window')
    self.window = attributes[:'window']
  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/healthcheck_response.rb, line 245
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      check_interval == o.check_interval &&
      comment == o.comment &&
      expected_response == o.expected_response &&
      headers == o.headers &&
      host == o.host &&
      http_version == o.http_version &&
      initial == o.initial &&
      method == o.method &&
      name == o.name &&
      path == o.path &&
      threshold == o.threshold &&
      timeout == o.timeout &&
      window == o.window &&
      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/healthcheck_response.rb, line 313
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/healthcheck_response.rb, line 384
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/healthcheck_response.rb, line 290
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/healthcheck_response.rb, line 270
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/healthcheck_response.rb, line 276
def hash
  [check_interval, comment, expected_response, headers, host, http_version, initial, method, name, path, threshold, timeout, window, 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/healthcheck_response.rb, line 232
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/fastly/models/healthcheck_response.rb, line 360
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/healthcheck_response.rb, line 366
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/healthcheck_response.rb, line 354
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/fastly/models/healthcheck_response.rb, line 239
def valid?
  true
end