Class: PinterestSdkClient::IntegrationLogClientRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/integration_log_client_request.rb

Overview

HTTP request details included in the log sent by the client.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ IntegrationLogClientRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::IntegrationLogClientRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::IntegrationLogClientRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

Instance Attribute Details

#host ⇒ Object

HTTP request host from host header.



20
21
22
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 20

def host
  @host
end

#method ⇒ Object

Returns the value of attribute method.



22
23
24
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 22

def method
  @method
end

#path ⇒ Object

HTTP request path.



25
26
27
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 25

def path
  @path
end

#request_headers ⇒ Object

HTTP request headers as key-value pairs.



28
29
30
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 28

def request_headers
  @request_headers
end

#response_headers ⇒ Object

HTTP response headers as key-value pairs.



31
32
33
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 31

def response_headers
  @response_headers
end

#response_status_code ⇒ Object

Returns the value of attribute response_status_code.



33
34
35
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 33

def response_status_code
  @response_status_code
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 58

def self.attribute_map
  {
    :'host' => :'host',
    :'method' => :'method',
    :'path' => :'path',
    :'request_headers' => :'request_headers',
    :'response_headers' => :'response_headers',
    :'response_status_code' => :'response_status_code'
  }
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 238

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 80

def self.openapi_types
  {
    :'host' => :'String',
    :'method' => :'String',
    :'path' => :'String',
    :'request_headers' => :'Hash<String, String>',
    :'response_headers' => :'Hash<String, String>',
    :'response_status_code' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      host == o.host &&
      method == o.method &&
      path == o.path &&
      request_headers == o.request_headers &&
      response_headers == o.response_headers &&
      response_status_code == o.response_status_code
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 231

def hash
  [host, method, path, request_headers, response_headers, response_status_code].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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 150

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 @path.nil?
    invalid_properties.push('invalid value for "path", path cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 260

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



170
171
172
173
174
175
176
177
178
 
# File 'lib/pinterest_sdk/models/integration_log_client_request.rb', line 170

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @host.nil?
  return false if @method.nil?
  method_validator = EnumAttributeValidator.new('String', ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"])
  return false unless method_validator.valid?(@method)
  return false if @path.nil?
  true
end