class Fastly::Header

Attributes

action[RW]

Accepts a string value.

cache_condition[RW]

Name of the cache condition controlling when this configuration applies.

dst[RW]

Header to set.

name[RW]

A handle to refer to this Header object.

regex[RW]

Regular expression to use. Only applies to ‘regex` and `regex_repeat` actions.

request_condition[RW]

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

response_condition[RW]

Optional name of a response condition to apply.

src[RW]

Variable to be used as a source for the header content. Does not apply to ‘delete` action.

substitution[RW]

Value to substitute in place of regular expression. Only applies to ‘regex` and `regex_repeat` actions.

type[RW]

Accepts a string value.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/header.rb, line 85
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/header.rb, line 69
def self.attribute_map
  {
    :'action' => :'action',
    :'cache_condition' => :'cache_condition',
    :'dst' => :'dst',
    :'name' => :'name',
    :'regex' => :'regex',
    :'request_condition' => :'request_condition',
    :'response_condition' => :'response_condition',
    :'src' => :'src',
    :'substitution' => :'substitution',
    :'type' => :'type'
  }
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/header.rb, line 242
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/header.rb, line 106
def self.fastly_nullable
  Set.new([
    :'cache_condition',
    :'regex',
    :'request_condition',
    :'response_condition',
    :'src',
    :'substitution',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/header.rb, line 90
def self.fastly_types
  {
    :'action' => :'String',
    :'cache_condition' => :'String',
    :'dst' => :'String',
    :'name' => :'String',
    :'regex' => :'String',
    :'request_condition' => :'String',
    :'response_condition' => :'String',
    :'src' => :'String',
    :'substitution' => :'String',
    :'type' => :'String'
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  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/header.rb, line 212
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      cache_condition == o.cache_condition &&
      dst == o.dst &&
      name == o.name &&
      regex == o.regex &&
      request_condition == o.request_condition &&
      response_condition == o.response_condition &&
      src == o.src &&
      substitution == o.substitution &&
      type == o.type
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/header.rb, line 272
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/header.rb, line 343
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
action=(action) click to toggle source

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

# File lib/fastly/models/header.rb, line 192
def action=(action)
  validator = EnumAttributeValidator.new('String', ["set", "append", "delete", "regex", "regex_repeat"])
  unless validator.valid?(action)
    fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
  end
  @action = action
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/header.rb, line 249
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/header.rb, line 229
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/header.rb, line 235
def hash
  [action, cache_condition, dst, name, regex, request_condition, response_condition, src, substitution, type].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/header.rb, line 175
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/header.rb, line 319
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/header.rb, line 325
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/header.rb, line 313
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/header.rb, line 202
def type=(type)
  validator = EnumAttributeValidator.new('String', ["request", "cache", "response"])
  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/header.rb, line 182
def valid?
  action_validator = EnumAttributeValidator.new('String', ["set", "append", "delete", "regex", "regex_repeat"])
  return false unless action_validator.valid?(@action)
  type_validator = EnumAttributeValidator.new('String', ["request", "cache", "response"])
  return false unless type_validator.valid?(@type)
  true
end