class Fastly::BackendResponse

Attributes

address[RW]

A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.

auto_loadbalance[RW]

Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don’t have a ‘request_condition` will be selected based on their `weight`.

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`.

client_cert[RW]

Unused.

comment[RW]

A freeform descriptive note.

connect_timeout[RW]

Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic ‘503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.

created_at[RW]

Date and time in ISO 8601 format.

deleted_at[RW]

Date and time in ISO 8601 format.

first_byte_timeout[RW]

Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic ‘503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.

healthcheck[RW]

The name of the healthcheck to use with this backend.

hostname[RW]

The hostname of the backend. May be used as an alternative to ‘address` to set the backend location.

ipv4[RW]

IPv4 address of the backend. May be used as an alternative to ‘address` to set the backend location.

ipv6[RW]

IPv6 address of the backend. May be used as an alternative to ‘address` to set the backend location.

keepalive_time[RW]

How long in seconds to keep a persistent connection to the backend between requests.

locked[RW]

Indicates whether the version of the service this backend is attached to accepts edits.

max_conn[RW]

Maximum number of concurrent connections this backend will accept.

max_tls_version[RW]

Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic ‘503` error response will be generated.

min_tls_version[RW]

Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic ‘503` error response will be generated.

name[RW]

The name of the backend.

override_host[RW]

If set, will replace the client-supplied HTTP ‘Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.

port[RW]

Port on which the backend server is listening for connections from Fastly. Setting ‘port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.

request_condition[RW]

Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any ‘auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.

service_id[RW]
share_key[RW]

Value that when shared across backends will enable those backends to share the same health check.

shield[RW]

Identifier of the POP to use as a [shield](docs.fastly.com/en/guides/shielding).

ssl_ca_cert[RW]

CA certificate attached to origin.

ssl_cert_hostname[RW]

Overrides ‘ssl_hostname`, but only for cert verification. Does not affect SNI at all.

ssl_check_cert[RW]

Be strict on checking SSL certs.

ssl_ciphers[RW]

List of [OpenSSL ciphers](www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic ‘503` error response will be generated.

ssl_client_cert[RW]

Client certificate attached to origin.

ssl_client_key[RW]

Client key attached to origin.

ssl_hostname[RW]

Use ‘ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.

ssl_sni_hostname[RW]

Overrides ‘ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.

tcp_keepalive_enable[RW]

Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.

tcp_keepalive_interval[RW]

Interval in seconds between subsequent keepalive probes.

tcp_keepalive_probes[RW]

Number of unacknowledged probes to send before considering the connection dead.

tcp_keepalive_time[RW]

Interval in seconds between the last data packet sent and the first keepalive probe.

updated_at[RW]

Date and time in ISO 8601 format.

use_ssl[RW]

Whether or not to require TLS for connections to this backend.

version[RW]
weight[RW]

Weight used to load balance this backend against others. May be any positive integer. If ‘auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/backend_response.rb, line 185
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/backend_response.rb, line 138
def self.attribute_map
  {
    :'address' => :'address',
    :'auto_loadbalance' => :'auto_loadbalance',
    :'between_bytes_timeout' => :'between_bytes_timeout',
    :'client_cert' => :'client_cert',
    :'comment' => :'comment',
    :'connect_timeout' => :'connect_timeout',
    :'first_byte_timeout' => :'first_byte_timeout',
    :'healthcheck' => :'healthcheck',
    :'hostname' => :'hostname',
    :'ipv4' => :'ipv4',
    :'ipv6' => :'ipv6',
    :'keepalive_time' => :'keepalive_time',
    :'max_conn' => :'max_conn',
    :'max_tls_version' => :'max_tls_version',
    :'min_tls_version' => :'min_tls_version',
    :'name' => :'name',
    :'override_host' => :'override_host',
    :'port' => :'port',
    :'request_condition' => :'request_condition',
    :'share_key' => :'share_key',
    :'shield' => :'shield',
    :'ssl_ca_cert' => :'ssl_ca_cert',
    :'ssl_cert_hostname' => :'ssl_cert_hostname',
    :'ssl_check_cert' => :'ssl_check_cert',
    :'ssl_ciphers' => :'ssl_ciphers',
    :'ssl_client_cert' => :'ssl_client_cert',
    :'ssl_client_key' => :'ssl_client_key',
    :'ssl_hostname' => :'ssl_hostname',
    :'ssl_sni_hostname' => :'ssl_sni_hostname',
    :'tcp_keepalive_enable' => :'tcp_keepalive_enable',
    :'tcp_keepalive_interval' => :'tcp_keepalive_interval',
    :'tcp_keepalive_probes' => :'tcp_keepalive_probes',
    :'tcp_keepalive_time' => :'tcp_keepalive_time',
    :'use_ssl' => :'use_ssl',
    :'weight' => :'weight',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'locked' => :'locked'
  }
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/backend_response.rb, line 554
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/backend_response.rb, line 270
def self.fastly_all_of
  [
  :'Backend',
  :'BackendResponseAllOf',
  :'ServiceIdAndVersion',
  :'Timestamps'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/backend_response.rb, line 237
def self.fastly_nullable
  Set.new([
    :'client_cert',
    :'comment',
    :'healthcheck',
    :'hostname',
    :'ipv4',
    :'ipv6',
    :'keepalive_time',
    :'max_tls_version',
    :'min_tls_version',
    :'override_host',
    :'share_key',
    :'shield',
    :'ssl_ca_cert',
    :'ssl_cert_hostname',
    :'ssl_check_cert',
    :'ssl_ciphers',
    :'ssl_client_cert',
    :'ssl_client_key',
    :'ssl_hostname',
    :'ssl_sni_hostname',
    :'tcp_keepalive_enable',
    :'tcp_keepalive_interval',
    :'tcp_keepalive_probes',
    :'tcp_keepalive_time',
    :'created_at',
    :'deleted_at',
    :'updated_at',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/backend_response.rb, line 190
def self.fastly_types
  {
    :'address' => :'String',
    :'auto_loadbalance' => :'Boolean',
    :'between_bytes_timeout' => :'Integer',
    :'client_cert' => :'String',
    :'comment' => :'String',
    :'connect_timeout' => :'Integer',
    :'first_byte_timeout' => :'Integer',
    :'healthcheck' => :'String',
    :'hostname' => :'String',
    :'ipv4' => :'String',
    :'ipv6' => :'String',
    :'keepalive_time' => :'Integer',
    :'max_conn' => :'Integer',
    :'max_tls_version' => :'String',
    :'min_tls_version' => :'String',
    :'name' => :'String',
    :'override_host' => :'String',
    :'port' => :'Integer',
    :'request_condition' => :'String',
    :'share_key' => :'String',
    :'shield' => :'String',
    :'ssl_ca_cert' => :'String',
    :'ssl_cert_hostname' => :'String',
    :'ssl_check_cert' => :'Boolean',
    :'ssl_ciphers' => :'String',
    :'ssl_client_cert' => :'String',
    :'ssl_client_key' => :'String',
    :'ssl_hostname' => :'String',
    :'ssl_sni_hostname' => :'String',
    :'tcp_keepalive_enable' => :'Boolean',
    :'tcp_keepalive_interval' => :'Integer',
    :'tcp_keepalive_probes' => :'Integer',
    :'tcp_keepalive_time' => :'Integer',
    :'use_ssl' => :'Boolean',
    :'weight' => :'Integer',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'version' => :'Integer',
    :'locked' => :'Boolean'
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  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?(:'healthcheck')
    self.healthcheck = attributes[:'healthcheck']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'ssl_check_cert')
    self.ssl_check_cert = attributes[:'ssl_check_cert']
  else
    self.ssl_check_cert = true
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'weight')
    self.weight = attributes[:'weight']
  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?(:'locked')
    self.locked = attributes[:'locked']
  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/backend_response.rb, line 493
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      auto_loadbalance == o.auto_loadbalance &&
      between_bytes_timeout == o.between_bytes_timeout &&
      client_cert == o.client_cert &&
      comment == o.comment &&
      connect_timeout == o.connect_timeout &&
      first_byte_timeout == o.first_byte_timeout &&
      healthcheck == o.healthcheck &&
      hostname == o.hostname &&
      ipv4 == o.ipv4 &&
      ipv6 == o.ipv6 &&
      keepalive_time == o.keepalive_time &&
      max_conn == o.max_conn &&
      max_tls_version == o.max_tls_version &&
      min_tls_version == o.min_tls_version &&
      name == o.name &&
      override_host == o.override_host &&
      port == o.port &&
      request_condition == o.request_condition &&
      share_key == o.share_key &&
      shield == o.shield &&
      ssl_ca_cert == o.ssl_ca_cert &&
      ssl_cert_hostname == o.ssl_cert_hostname &&
      ssl_check_cert == o.ssl_check_cert &&
      ssl_ciphers == o.ssl_ciphers &&
      ssl_client_cert == o.ssl_client_cert &&
      ssl_client_key == o.ssl_client_key &&
      ssl_hostname == o.ssl_hostname &&
      ssl_sni_hostname == o.ssl_sni_hostname &&
      tcp_keepalive_enable == o.tcp_keepalive_enable &&
      tcp_keepalive_interval == o.tcp_keepalive_interval &&
      tcp_keepalive_probes == o.tcp_keepalive_probes &&
      tcp_keepalive_time == o.tcp_keepalive_time &&
      use_ssl == o.use_ssl &&
      weight == o.weight &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      version == o.version &&
      locked == o.locked
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/backend_response.rb, line 584
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/backend_response.rb, line 655
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/backend_response.rb, line 561
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/backend_response.rb, line 541
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/backend_response.rb, line 547
def hash
  [address, auto_loadbalance, between_bytes_timeout, client_cert, comment, connect_timeout, first_byte_timeout, healthcheck, hostname, ipv4, ipv6, keepalive_time, max_conn, max_tls_version, min_tls_version, name, override_host, port, request_condition, share_key, shield, ssl_ca_cert, ssl_cert_hostname, ssl_check_cert, ssl_ciphers, ssl_client_cert, ssl_client_key, ssl_hostname, ssl_sni_hostname, tcp_keepalive_enable, tcp_keepalive_interval, tcp_keepalive_probes, tcp_keepalive_time, use_ssl, weight, created_at, deleted_at, updated_at, service_id, version, locked].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/backend_response.rb, line 463
def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^[A-Za-z0-9]+$/)
  if !@share_key.nil? && @share_key !~ pattern
    invalid_properties.push("invalid value for \"share_key\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end
share_key=(share_key) click to toggle source

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

# File lib/fastly/models/backend_response.rb, line 482
def share_key=(share_key)
  pattern = Regexp.new(/^[A-Za-z0-9]+$/)
  if !share_key.nil? && share_key !~ pattern
    fail ArgumentError, "invalid value for \"share_key\", must conform to the pattern #{pattern}."
  end

  @share_key = share_key
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/backend_response.rb, line 631
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/backend_response.rb, line 637
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/backend_response.rb, line 625
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/backend_response.rb, line 475
def valid?
  return false if !@share_key.nil? && @share_key !~ Regexp.new(/^[A-Za-z0-9]+$/)
  true
end