class Fastly::PoolAdditional
Attributes
A freeform descriptive note.
Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.
Maximum allowed TLS version on connections to this server. Optional.
Minimum allowed TLS version on connections to this server. Optional.
Name for the Pool.
The hostname to [override the Host header](www.fastly.com/documentation/guides/full-site-delivery/domains-and-origins/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.
Condition
which, if met, will select this configuration during a request. Optional.
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.
List of OpenSSL ciphers (see the [openssl.org manpages](www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.
SNI hostname. Optional.
What type of load balance group to use.
Public Class Methods
Source
# File lib/fastly/models/pool_additional.rb, line 89 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/fastly/models/pool_additional.rb, line 72 def self.attribute_map { :'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' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/fastly/models/pool_additional.rb, line 247 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/fastly/models/pool_additional.rb, line 111 def self.fastly_nullable Set.new([ :'shield', :'request_condition', :'tls_ciphers', :'tls_sni_hostname', :'min_tls_version', :'max_tls_version', :'healthcheck', :'comment', :'override_host' ]) end
List of attributes with nullable: true
Source
# File lib/fastly/models/pool_additional.rb, line 94 def self.fastly_types { :'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' } end
Attribute type mapping.
Source
# File lib/fastly/models/pool_additional.rb, line 127 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::PoolAdditional` 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::PoolAdditional`. 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?(:'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 end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Public Instance Methods
Source
# File lib/fastly/models/pool_additional.rb, line 216 def ==(o) return true if self.equal?(o) self.class == o.class && 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 end
Checks equality by comparing each attribute. @param [Object] Object
to be compared
Source
# File lib/fastly/models/pool_additional.rb, line 277 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/fastly/models/pool_additional.rb, line 348 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
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
Source
# File lib/fastly/models/pool_additional.rb, line 254 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/fastly/models/pool_additional.rb, line 234 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object
to be compared
Source
# File lib/fastly/models/pool_additional.rb, line 240 def hash [name, shield, request_condition, tls_ciphers, tls_sni_hostname, min_tls_version, max_tls_version, healthcheck, comment, type, override_host].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/fastly/models/pool_additional.rb, line 191 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/fastly/models/pool_additional.rb, line 330 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/fastly/models/pool_additional.rb, line 318 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/fastly/models/pool_additional.rb, line 206 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
Custom attribute writer method checking allowed values (enum). @param [Object] type Object
to be assigned
Source
# File lib/fastly/models/pool_additional.rb, line 198 def valid? type_validator = EnumAttributeValidator.new('String', ["random", "hash", "client"]) return false unless type_validator.valid?(@type) true end
Check to see if the all the properties in the model are valid @return true if the model is valid