Class: Fastly::PublishItemFormats

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/publish_item_formats.rb

Overview

Transport-specific message payload representations to be used for delivery. At least one format (‘http-response`, `http-stream`, and/or `ws-message`) must be specified. Messages are only delivered to subscribers interested in the provided formats. For example, the `ws-message` format will only be sent to WebSocket clients.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublishItemFormats

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/fastly/models/publish_item_formats.rb', line 54

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::PublishItemFormats` 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::PublishItemFormats`. 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?(:'http_response')
    self.http_response = attributes[:'http_response']
  end

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

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

Instance Attribute Details

#http_response ⇒ Object

Returns the value of attribute http_response.



17
18
19
 
# File 'lib/fastly/models/publish_item_formats.rb', line 17

def http_response
  @http_response
end

#http_stream ⇒ Object

Returns the value of attribute http_stream.



19
20
21
 
# File 'lib/fastly/models/publish_item_formats.rb', line 19

def http_stream
  @http_stream
end

#ws_message ⇒ Object

Returns the value of attribute ws_message.



21
22
23
 
# File 'lib/fastly/models/publish_item_formats.rb', line 21

def ws_message
  @ws_message
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



33
34
35
 
# File 'lib/fastly/models/publish_item_formats.rb', line 33

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



24
25
26
27
28
29
30
 
# File 'lib/fastly/models/publish_item_formats.rb', line 24

def self.attribute_map
  {
    :'http_response' => :'http-response',
    :'http_stream' => :'http-stream',
    :'ws_message' => :'ws-message'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



118
119
120
 
# File 'lib/fastly/models/publish_item_formats.rb', line 118

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



47
48
49
50
 
# File 'lib/fastly/models/publish_item_formats.rb', line 47

def self.fastly_nullable
  Set.new([
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
 
# File 'lib/fastly/models/publish_item_formats.rb', line 38

def self.fastly_types
  {
    :'http_response' => :'HttpResponseFormat',
    :'http_stream' => :'HttpStreamFormat',
    :'ws_message' => :'WsMessageFormat'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



95
96
97
98
99
100
101
 
# File 'lib/fastly/models/publish_item_formats.rb', line 95

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      http_response == o.http_response &&
      http_stream == o.http_stream &&
      ws_message == o.ws_message
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/fastly/models/publish_item_formats.rb', line 148

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/fastly/models/publish_item_formats.rb', line 219

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/fastly/models/publish_item_formats.rb', line 125

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


105
106
107
 
# File 'lib/fastly/models/publish_item_formats.rb', line 105

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



111
112
113
 
# File 'lib/fastly/models/publish_item_formats.rb', line 111

def hash
  [http_response, http_stream, ws_message].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



82
83
84
85
 
# File 'lib/fastly/models/publish_item_formats.rb', line 82

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
 
# File 'lib/fastly/models/publish_item_formats.rb', line 195

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/fastly/models/publish_item_formats.rb', line 201

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



189
190
191
 
# File 'lib/fastly/models/publish_item_formats.rb', line 189

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



89
90
91
 
# File 'lib/fastly/models/publish_item_formats.rb', line 89

def valid?
  true
end