class Fastly::HeaderResponse
Attributes
Accepts a string value.
Name of the cache condition controlling when this configuration applies.
Date and time in ISO 8601 format.
Date and time in ISO 8601 format.
Header
to set.
Don’t add the header if it is added already. Only applies to ‘set’ action. Numerical value ("0" = false, "1" = true)
A handle to refer to this Header
object.
Priority determines execution order. Lower numbers execute first.
Regular expression to use. Only applies to ‘regex` and `regex_repeat` actions.
Condition
which, if met, will select this configuration during a request. Optional.
Optional name of a response condition to apply.
Variable to be used as a source for the header content. Does not apply to ‘delete` action.
Value to substitute in place of regular expression. Only applies to ‘regex` and `regex_repeat` actions.
Accepts a string value.
Date and time in ISO 8601 format.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/fastly/models/header_response.rb, line 111 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/fastly/models/header_response.rb, line 88 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', :'ignore_if_set' => :'ignore_if_set', :'priority' => :'priority', :'service_id' => :'service_id', :'version' => :'version', :'created_at' => :'created_at', :'deleted_at' => :'deleted_at', :'updated_at' => :'updated_at' } end
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_response.rb, line 325 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
List of class defined in allOf (OpenAPI v3)
# File lib/fastly/models/header_response.rb, line 154 def self.fastly_all_of [ :'Header', :'HeaderResponseAdditional', :'ServiceIdAndVersionString', :'Timestamps' ] end
List of attributes with nullable: true
# File lib/fastly/models/header_response.rb, line 139 def self.fastly_nullable Set.new([ :'cache_condition', :'regex', :'request_condition', :'response_condition', :'src', :'substitution', :'created_at', :'deleted_at', :'updated_at' ]) end
Attribute type mapping.
# File lib/fastly/models/header_response.rb, line 116 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', :'ignore_if_set' => :'String', :'priority' => :'String', :'service_id' => :'String', :'version' => :'String', :'created_at' => :'Time', :'deleted_at' => :'Time', :'updated_at' => :'Time' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/fastly/models/header_response.rb, line 165 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HeaderResponse` 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::HeaderResponse`. 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 if attributes.key?(:'ignore_if_set') self.ignore_if_set = attributes[:'ignore_if_set'] end if attributes.key?(:'priority') self.priority = attributes[:'priority'] else self.priority = '100' 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
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/fastly/models/header_response.rb, line 288 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 && ignore_if_set == o.ignore_if_set && priority == o.priority && service_id == o.service_id && version == o.version && created_at == o.created_at && deleted_at == o.deleted_at && updated_at == o.updated_at end
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_response.rb, line 355 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
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_response.rb, line 426 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
Custom attribute writer method checking allowed values (enum). @param [Object] action Object
to be assigned
# File lib/fastly/models/header_response.rb, line 268 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
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_response.rb, line 332 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
@see the ‘==` method @param [Object] Object
to be compared
# File lib/fastly/models/header_response.rb, line 312 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/fastly/models/header_response.rb, line 318 def hash [action, cache_condition, dst, name, regex, request_condition, response_condition, src, substitution, type, ignore_if_set, priority, service_id, version, created_at, deleted_at, updated_at].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/fastly/models/header_response.rb, line 251 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/fastly/models/header_response.rb, line 408 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 string representation of the object @return [String] String presentation of the object
# File lib/fastly/models/header_response.rb, line 396 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object
to be assigned
# File lib/fastly/models/header_response.rb, line 278 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
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_response.rb, line 258 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