Class: PinterestSdkClient::IntegrationLogClientError

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

Overview

System error details included in the log sent by the client.

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 = {}) ⇒ IntegrationLogClientError

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#causeObject

Original cause of the error.



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

def cause
  @cause
end

#column_numberObject

Column number in the line of the file that raised the error.



23
24
25
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 23

def column_number
  @column_number
end

#file_nameObject

Filename where the error happened.



26
27
28
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 26

def file_name
  @file_name
end

#line_numberObject

Line number where the error happened.



29
30
31
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 29

def line_number
  @line_number
end

#messageObject

Human-readable description of the error.



32
33
34
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 32

def message
  @message
end

#message_detailObject

More detail about the message.



35
36
37
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 35

def message_detail
  @message_detail
end

#nameObject

Filename where the error happened.



38
39
40
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 38

def name
  @name
end

#numberObject

Integer that specifies the error code.



41
42
43
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 41

def number
  @number
end

#stack_traceObject

Stack trace of where the error happened.



44
45
46
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 44

def stack_trace
  @stack_trace
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



62
63
64
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



67
68
69
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 47

def self.attribute_map
  {
    :'cause' => :'cause',
    :'column_number' => :'column_number',
    :'file_name' => :'file_name',
    :'line_number' => :'line_number',
    :'message' => :'message',
    :'message_detail' => :'message_detail',
    :'name' => :'name',
    :'number' => :'number',
    :'stack_trace' => :'stack_trace'
  }
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 286

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_nullableObject

List of attributes with nullable: true



87
88
89
90
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 87

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

.openapi_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 72

def self.openapi_types
  {
    :'cause' => :'String',
    :'column_number' => :'Integer',
    :'file_name' => :'String',
    :'line_number' => :'Integer',
    :'message' => :'String',
    :'message_detail' => :'String',
    :'name' => :'String',
    :'number' => :'Integer',
    :'stack_trace' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cause == o.cause &&
      column_number == o.column_number &&
      file_name == o.file_name &&
      line_number == o.line_number &&
      message == o.message &&
      message_detail == o.message_detail &&
      name == o.name &&
      number == o.number &&
      stack_trace == o.stack_trace
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 273

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



279
280
281
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 279

def hash
  [cause, column_number, file_name, line_number, message, message_detail, name, number, stack_trace].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 147

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@cause.nil? && @cause.to_s.length > 512
    invalid_properties.push('invalid value for "cause", the character length must be smaller than or equal to 512.')
  end

  if !@file_name.nil? && @file_name.to_s.length > 256
    invalid_properties.push('invalid value for "file_name", the character length must be smaller than or equal to 256.')
  end

  if !@message.nil? && @message.to_s.length > 8192
    invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 8192.')
  end

  if !@message_detail.nil? && @message_detail.to_s.length > 1024
    invalid_properties.push('invalid value for "message_detail", the character length must be smaller than or equal to 1024.')
  end

  if !@name.nil? && @name.to_s.length > 256
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 256.')
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 308

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



175
176
177
178
179
180
181
182
183
# File 'lib/pinterest_sdk/models/integration_log_client_error.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@cause.nil? && @cause.to_s.length > 512
  return false if !@file_name.nil? && @file_name.to_s.length > 256
  return false if !@message.nil? && @message.to_s.length > 8192
  return false if !@message_detail.nil? && @message_detail.to_s.length > 1024
  return false if !@name.nil? && @name.to_s.length > 256
  true
end