Class: Hubspot::Crm::Timeline::Error
- Inherits:
-
Object
- Object
- Hubspot::Crm::Timeline::Error
- Defined in:
- lib/hubspot/codegen/crm/timeline/models/error.rb
Instance Attribute Summary collapse
-
#category ⇒ Object
The error category.
-
#context ⇒ Object
Context about the error condition.
-
#correlation_id ⇒ Object
A unique identifier for the request.
-
#errors ⇒ Object
further information about the error.
-
#links ⇒ Object
A map of link names to associated URIs containing documentation about the error or recommended remediation steps.
-
#message ⇒ Object
A human readable message describing the error along with remediation steps where appropriate.
-
#sub_category ⇒ Object
A specific category that contains more specific detail about the error.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Error
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Error
Initializes the object
80 81 82 83 84 85 86 87 88 89 90 91 92 93 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 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 80 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Timeline::Error` 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 `Hubspot::Crm::Timeline::Error`. 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?(:'sub_category') self.sub_category = attributes[:'sub_category'] end if attributes.key?(:'context') if (value = attributes[:'context']).is_a?(Hash) self.context = value end end if attributes.key?(:'correlation_id') self.correlation_id = attributes[:'correlation_id'] end if attributes.key?(:'links') if (value = attributes[:'links']).is_a?(Hash) self.links = value end end if attributes.key?(:'message') self. = attributes[:'message'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'errors') if (value = attributes[:'errors']).is_a?(Array) self.errors = value end end end |
Instance Attribute Details
#category ⇒ Object
The error category
36 37 38 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 36 def category @category end |
#context ⇒ Object
Context about the error condition
24 25 26 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 24 def context @context end |
#correlation_id ⇒ Object
A unique identifier for the request. Include this value with any error reports or support tickets
27 28 29 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 27 def correlation_id @correlation_id end |
#errors ⇒ Object
further information about the error
39 40 41 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 39 def errors @errors end |
#links ⇒ Object
A map of link names to associated URIs containing documentation about the error or recommended remediation steps
30 31 32 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 30 def links @links end |
#message ⇒ Object
A human readable message describing the error along with remediation steps where appropriate
33 34 35 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 33 def @message end |
#sub_category ⇒ Object
A specific category that contains more specific detail about the error
21 22 23 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 21 def sub_category @sub_category end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
55 56 57 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 55 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 42 def self.attribute_map { :'sub_category' => :'subCategory', :'context' => :'context', :'correlation_id' => :'correlationId', :'links' => :'links', :'message' => :'message', :'category' => :'category', :'errors' => :'errors' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
185 186 187 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 185 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
73 74 75 76 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 73 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 60 def self.openapi_types { :'sub_category' => :'String', :'context' => :'Hash<String, Array<String>>', :'correlation_id' => :'String', :'links' => :'Hash<String, String>', :'message' => :'String', :'category' => :'String', :'errors' => :'Array<ErrorDetail>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 158 def ==(o) return true if self.equal?(o) self.class == o.class && sub_category == o.sub_category && context == o.context && correlation_id == o.correlation_id && links == o.links && == o. && category == o.category && errors == o.errors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 216 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 = Hubspot::Crm::Timeline.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
287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 287 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
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 192 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
172 173 174 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 172 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
178 179 180 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 178 def hash [sub_category, context, correlation_id, links, , category, errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 130 def list_invalid_properties invalid_properties = Array.new if @correlation_id.nil? invalid_properties.push('invalid value for "correlation_id", correlation_id cannot be nil.') end if @message.nil? invalid_properties.push('invalid value for "message", message cannot be nil.') end if @category.nil? invalid_properties.push('invalid value for "category", category cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
263 264 265 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 263 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 269 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
257 258 259 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 257 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
149 150 151 152 153 154 |
# File 'lib/hubspot/codegen/crm/timeline/models/error.rb', line 149 def valid? return false if @correlation_id.nil? return false if @message.nil? return false if @category.nil? true end |