Class: OpenapiClient::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/lib/openapi_client/models/request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Request

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 95

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

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  else
    self.method = 'GET'
  end

  if attributes.key?(:'secure')
    self.secure = attributes[:'secure']
  else
    self.secure = true
  end

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

  if attributes.key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 10
  end

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

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

  if attributes.key?(:'sensitive')
    if (value = attributes[:'sensitive']).is_a?(Array)
      self.sensitive = value
    end
  end

  if attributes.key?(:'content_type')
    self.content_type = attributes[:'content_type']
  else
    self.content_type = 'application/json'
  end

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

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

Instance Attribute Details

#body ⇒ Object

a string representing the HTTP request or response body



36
37
38
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 36

def body
  @body
end

#content_type ⇒ Object

Returns the value of attribute content_type.



41
42
43
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 41

def content_type
  @content_type
end

#headers ⇒ Object

any custom headers that should also be forwarded with the request



27
28
29
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 27

def headers
  @headers
end

#host ⇒ Object

the destination host of the request to be made



19
20
21
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 19

def host
  @host
end

#method ⇒ Object

Returns the value of attribute method.



21
22
23
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 21

def method
  @method
end

#params ⇒ Object

a JSON object whose key/value pairs will be mapped to URL query parameters



33
34
35
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 33

def params
  @params
end

#path ⇒ Object

the path in the URL from the host; query parameters should not be included here



46
47
48
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 46

def path
  @path
end

#redirect ⇒ Object

Returns the value of attribute redirect.



43
44
45
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 43

def redirect
  @redirect
end

#secure ⇒ Object

boolean to indicate if the request should be made over HTTPS or not; default is secure



24
25
26
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 24

def secure
  @secure
end

#sensitive ⇒ Object

any sensitive keys that are used in URL parameters or in the HTTP body; keys marked as sensitive will be automatically scubbed



39
40
41
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 39

def sensitive
  @sensitive
end

#timeout ⇒ Object

a timeout length in seconds for the HTTP request to return; default is 10 seconds



30
31
32
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 30

def timeout
  @timeout
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 49

def self.attribute_map
  {
    :'host' => :'host',
    :'method' => :'method',
    :'secure' => :'secure',
    :'headers' => :'headers',
    :'timeout' => :'timeout',
    :'params' => :'params',
    :'body' => :'body',
    :'sensitive' => :'sensitive',
    :'content_type' => :'content_type',
    :'redirect' => :'redirect',
    :'path' => :'path'
  }
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



263
264
265
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 263

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 71

def self.openapi_types
  {
    :'host' => :'String',
    :'method' => :'Method',
    :'secure' => :'Boolean',
    :'headers' => :'Object',
    :'timeout' => :'Integer',
    :'params' => :'Object',
    :'body' => :'String',
    :'sensitive' => :'Array<String>',
    :'content_type' => :'ContentType',
    :'redirect' => :'Redirect',
    :'path' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      host == o.host &&
      method == o.method &&
      secure == o.secure &&
      headers == o.headers &&
      timeout == o.timeout &&
      params == o.params &&
      body == o.body &&
      sensitive == o.sensitive &&
      content_type == o.content_type &&
      redirect == o.redirect &&
      path == o.path
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 294

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 = OpenapiClient.const_get(type)
    klass.respond_to?(:openapi_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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 365

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 270

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_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


250
251
252
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 256

def hash
  [host, method, secure, headers, timeout, params, body, sensitive, content_type, redirect, path].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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 169

def list_invalid_properties
  invalid_properties = Array.new
  if @host.nil?
    invalid_properties.push('invalid value for "host", host cannot be nil.')
  end

  if @method.nil?
    invalid_properties.push('invalid value for "method", method cannot be nil.')
  end

  if @secure.nil?
    invalid_properties.push('invalid value for "secure", secure cannot be nil.')
  end

  if @headers.nil?
    invalid_properties.push('invalid value for "headers", headers cannot be nil.')
  end

  if @timeout.nil?
    invalid_properties.push('invalid value for "timeout", timeout cannot be nil.')
  end

  if @params.nil?
    invalid_properties.push('invalid value for "params", params cannot be nil.')
  end

  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

  if @sensitive.nil?
    invalid_properties.push('invalid value for "sensitive", sensitive cannot be nil.')
  end

  if @content_type.nil?
    invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
  end

  if @path.nil?
    invalid_properties.push('invalid value for "path", path cannot be nil.')
  end

  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



341
342
343
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 341

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 347

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_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



335
336
337
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 335

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/openapi_client/lib/openapi_client/models/request.rb', line 216

def valid?
  return false if @host.nil?
  return false if @method.nil?
  return false if @secure.nil?
  return false if @headers.nil?
  return false if @timeout.nil?
  return false if @params.nil?
  return false if @body.nil?
  return false if @sensitive.nil?
  return false if @content_type.nil?
  return false if @path.nil?
  true
end