Class: OCI::Analytics::Models::WorkRequestError

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/analytics/models/work_request_error.rb

Overview

Error encountered during the execution of a work request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkRequestError

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :code (String)

    The value to assign to the #code property

  • :message (String)

    The value to assign to the #message property

  • :timestamp (DateTime)

    The value to assign to the #timestamp property



60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/oci/analytics/models/work_request_error.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.code = attributes[:'code'] if attributes[:'code']

  self.message = attributes[:'message'] if attributes[:'message']

  self.timestamp = attributes[:'timestamp'] if attributes[:'timestamp']
end

Instance Attribute Details

#codeString

[Required] A short error code that defines the error, meant for programmatic parsing.

Returns:

  • (String)


15
16
17
# File 'lib/oci/analytics/models/work_request_error.rb', line 15

def code
  @code
end

#messageString

[Required] Error message.

Returns:

  • (String)


20
21
22
# File 'lib/oci/analytics/models/work_request_error.rb', line 20

def message
  @message
end

#timestampDateTime

[Required] The date and time the error occured, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


27
28
29
# File 'lib/oci/analytics/models/work_request_error.rb', line 27

def timestamp
  @timestamp
end

Class Method Details

.attribute_mapObject

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



30
31
32
33
34
35
36
37
38
# File 'lib/oci/analytics/models/work_request_error.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'code',
    'message': :'message',
    'timestamp': :'timestamp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



41
42
43
44
45
46
47
48
49
# File 'lib/oci/analytics/models/work_request_error.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'String',
    'message': :'String',
    'timestamp': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



80
81
82
83
84
85
86
87
# File 'lib/oci/analytics/models/work_request_error.rb', line 80

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    code == other.code &&
    message == other.message &&
    timestamp == other.timestamp
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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/oci/analytics/models/work_request_error.rb', line 112

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


92
93
94
# File 'lib/oci/analytics/models/work_request_error.rb', line 92

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



101
102
103
# File 'lib/oci/analytics/models/work_request_error.rb', line 101

def hash
  [code, message, timestamp].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



145
146
147
148
149
150
151
152
153
154
# File 'lib/oci/analytics/models/work_request_error.rb', line 145

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



139
140
141
# File 'lib/oci/analytics/models/work_request_error.rb', line 139

def to_s
  to_hash.to_s
end