class Fastly::PoolResponsePost

Attributes

between_bytes_timeout[RW]

Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using ‘bereq.between_bytes_timeout`.

comment[RW]

A freeform descriptive note.

connect_timeout[RW]

How long to wait for a timeout in milliseconds.

created_at[RW]

Date and time in ISO 8601 format.

deleted_at[RW]

Date and time in ISO 8601 format.

first_byte_timeout[RW]

How long to wait for the first byte in milliseconds.

healthcheck[RW]

Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.

id[RW]
max_conn_default[RW]

Maximum number of connections.

max_tls_version[RW]

Maximum allowed TLS version on connections to this server. Optional.

min_tls_version[RW]

Minimum allowed TLS version on connections to this server. Optional.

name[RW]

Name for the Pool.

override_host[RW]

The hostname to [override the Host header](docs.fastly.com/en/guides/specifying-an-override-host). Defaults to ‘null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting.

quorum[RW]

Percentage of capacity (‘0-100`) that needs to be operationally available for a pool to be considered up.

request_condition[RW]

Condition which, if met, will select this configuration during a request. Optional.

service_id[RW]
shield[RW]

Selected POP to serve as a shield for the servers. 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.

tls_ca_cert[RW]

A secure certificate to authenticate a server with. Must be in PEM format.

tls_cert_hostname[RW]

The hostname used to verify a server’s certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN).

tls_check_cert[RW]

Be strict on checking TLS certs.

tls_ciphers[RW]

List of OpenSSL ciphers (see the [openssl.org manpages](www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.

tls_client_cert[RW]

The client certificate used to make authenticated requests. Must be in PEM format.

tls_client_key[RW]

The client private key used to make authenticated requests. Must be in PEM format.

tls_sni_hostname[RW]

SNI hostname. Optional.

type[RW]

What type of load balance group to use.

updated_at[RW]

Date and time in ISO 8601 format.

use_tls[RW]

Whether to use TLS.

version[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/pool_response_post.rb, line 154
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/pool_response_post.rb, line 120
def self.attribute_map
  {
    :'tls_ca_cert' => :'tls_ca_cert',
    :'tls_client_cert' => :'tls_client_cert',
    :'tls_client_key' => :'tls_client_key',
    :'tls_cert_hostname' => :'tls_cert_hostname',
    :'use_tls' => :'use_tls',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'name' => :'name',
    :'shield' => :'shield',
    :'request_condition' => :'request_condition',
    :'tls_ciphers' => :'tls_ciphers',
    :'tls_sni_hostname' => :'tls_sni_hostname',
    :'min_tls_version' => :'min_tls_version',
    :'max_tls_version' => :'max_tls_version',
    :'healthcheck' => :'healthcheck',
    :'comment' => :'comment',
    :'type' => :'type',
    :'override_host' => :'override_host',
    :'between_bytes_timeout' => :'between_bytes_timeout',
    :'connect_timeout' => :'connect_timeout',
    :'first_byte_timeout' => :'first_byte_timeout',
    :'max_conn_default' => :'max_conn_default',
    :'tls_check_cert' => :'tls_check_cert',
    :'id' => :'id',
    :'quorum' => :'quorum'
  }
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/pool_response_post.rb, line 460
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/pool_response_post.rb, line 216
def self.fastly_all_of
  [
  :'PoolAdditional',
  :'PoolResponseCommon',
  :'PoolResponsePostAllOf',
  :'ServiceIdAndVersionString',
  :'Timestamps',
  :'TlsCommonResponse'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/pool_response_post.rb, line 193
def self.fastly_nullable
  Set.new([
    :'tls_ca_cert',
    :'tls_client_cert',
    :'tls_client_key',
    :'tls_cert_hostname',
    :'created_at',
    :'deleted_at',
    :'updated_at',
    :'shield',
    :'request_condition',
    :'tls_ciphers',
    :'tls_sni_hostname',
    :'min_tls_version',
    :'max_tls_version',
    :'healthcheck',
    :'comment',
    :'override_host',
    :'tls_check_cert',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/pool_response_post.rb, line 159
def self.fastly_types
  {
    :'tls_ca_cert' => :'String',
    :'tls_client_cert' => :'String',
    :'tls_client_key' => :'String',
    :'tls_cert_hostname' => :'String',
    :'use_tls' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'version' => :'String',
    :'name' => :'String',
    :'shield' => :'String',
    :'request_condition' => :'String',
    :'tls_ciphers' => :'String',
    :'tls_sni_hostname' => :'String',
    :'min_tls_version' => :'Integer',
    :'max_tls_version' => :'Integer',
    :'healthcheck' => :'String',
    :'comment' => :'String',
    :'type' => :'String',
    :'override_host' => :'String',
    :'between_bytes_timeout' => :'String',
    :'connect_timeout' => :'String',
    :'first_byte_timeout' => :'String',
    :'max_conn_default' => :'String',
    :'tls_check_cert' => :'String',
    :'id' => :'String',
    :'quorum' => :'Integer'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/fastly/models/pool_response_post.rb, line 229
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::PoolResponsePost` 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::PoolResponsePost`. 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?(:'tls_ca_cert')
    self.tls_ca_cert = attributes[:'tls_ca_cert']
  else
    self.tls_ca_cert = 'null'
  end

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

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

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

  if attributes.key?(:'use_tls')
    self.use_tls = attributes[:'use_tls']
  else
    self.use_tls = '0'
  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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'max_conn_default')
    self.max_conn_default = attributes[:'max_conn_default']
  else
    self.max_conn_default = '200'
  end

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

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

  if attributes.key?(:'quorum')
    self.quorum = attributes[:'quorum']
  else
    self.quorum = 75
  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/pool_response_post.rb, line 412
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tls_ca_cert == o.tls_ca_cert &&
      tls_client_cert == o.tls_client_cert &&
      tls_client_key == o.tls_client_key &&
      tls_cert_hostname == o.tls_cert_hostname &&
      use_tls == o.use_tls &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      version == o.version &&
      name == o.name &&
      shield == o.shield &&
      request_condition == o.request_condition &&
      tls_ciphers == o.tls_ciphers &&
      tls_sni_hostname == o.tls_sni_hostname &&
      min_tls_version == o.min_tls_version &&
      max_tls_version == o.max_tls_version &&
      healthcheck == o.healthcheck &&
      comment == o.comment &&
      type == o.type &&
      override_host == o.override_host &&
      between_bytes_timeout == o.between_bytes_timeout &&
      connect_timeout == o.connect_timeout &&
      first_byte_timeout == o.first_byte_timeout &&
      max_conn_default == o.max_conn_default &&
      tls_check_cert == o.tls_check_cert &&
      id == o.id &&
      quorum == o.quorum
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/pool_response_post.rb, line 490
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/pool_response_post.rb, line 561
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/pool_response_post.rb, line 467
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/pool_response_post.rb, line 447
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/pool_response_post.rb, line 453
def hash
  [tls_ca_cert, tls_client_cert, tls_client_key, tls_cert_hostname, use_tls, created_at, deleted_at, updated_at, service_id, version, name, shield, request_condition, tls_ciphers, tls_sni_hostname, min_tls_version, max_tls_version, healthcheck, comment, type, override_host, between_bytes_timeout, connect_timeout, first_byte_timeout, max_conn_default, tls_check_cert, id, quorum].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/pool_response_post.rb, line 375
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/pool_response_post.rb, line 537
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/pool_response_post.rb, line 543
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/pool_response_post.rb, line 531
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/pool_response_post.rb, line 402
def type=(type)
  validator = EnumAttributeValidator.new('String', ["random", "hash", "client"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
end
use_tls=(use_tls) click to toggle source

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

# File lib/fastly/models/pool_response_post.rb, line 392
def use_tls=(use_tls)
  validator = EnumAttributeValidator.new('String', ["0", "1"])
  unless validator.valid?(use_tls)
    fail ArgumentError, "invalid value for \"use_tls\", must be one of #{validator.allowable_values}."
  end
  @use_tls = use_tls
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/pool_response_post.rb, line 382
def valid?
  use_tls_validator = EnumAttributeValidator.new('String', ["0", "1"])
  return false unless use_tls_validator.valid?(@use_tls)
  type_validator = EnumAttributeValidator.new('String', ["random", "hash", "client"])
  return false unless type_validator.valid?(@type)
  true
end