class Fastly::HttpResponseFormat
Payload format for delivering to subscribers of whole HTTP responses (‘response` hold mode). One of `body` or `body-bin` must be specified.
Attributes
The response body as a string.
The response body as a base64-encoded binary blob.
The HTTP status code.
A map of arbitrary HTTP response headers to include in the response.
The HTTP status string. Defaults to a string appropriate for ‘code`.
Public Class Methods
Source
# File lib/fastly/models/http_response_format.rb, line 44 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/fastly/models/http_response_format.rb, line 33 def self.attribute_map { :'code' => :'code', :'reason' => :'reason', :'headers' => :'headers', :'body' => :'body', :'body_bin' => :'body-bin' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/fastly/models/http_response_format.rb, line 145 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/http_response_format.rb, line 60 def self.fastly_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/fastly/models/http_response_format.rb, line 49 def self.fastly_types { :'code' => :'Integer', :'reason' => :'String', :'headers' => :'Hash<String, String>', :'body' => :'String', :'body_bin' => :'String' } end
Attribute type mapping.
Source
# File lib/fastly/models/http_response_format.rb, line 67 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HttpResponseFormat` 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::HttpResponseFormat`. 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?(:'code') self.code = attributes[:'code'] else self.code = 200 end if attributes.key?(:'reason') self.reason = attributes[:'reason'] end if attributes.key?(:'headers') if (value = attributes[:'headers']).is_a?(Hash) self.headers = value end end if attributes.key?(:'body') self.body = attributes[:'body'] end if attributes.key?(:'body_bin') self.body_bin = attributes[:'body_bin'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Public Instance Methods
Source
# File lib/fastly/models/http_response_format.rb, line 120 def ==(o) return true if self.equal?(o) self.class == o.class && code == o.code && reason == o.reason && headers == o.headers && body == o.body && body_bin == o.body_bin end
Checks equality by comparing each attribute. @param [Object] Object
to be compared
Source
# File lib/fastly/models/http_response_format.rb, line 175 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/http_response_format.rb, line 246 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/http_response_format.rb, line 152 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/http_response_format.rb, line 132 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object
to be compared
Source
# File lib/fastly/models/http_response_format.rb, line 138 def hash [code, reason, headers, body, body_bin].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/fastly/models/http_response_format.rb, line 107 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/http_response_format.rb, line 228 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/http_response_format.rb, line 216 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/http_response_format.rb, line 114 def valid? true end
Check to see if the all the properties in the model are valid @return true if the model is valid