class OCI::Devops::Models::WorkRequestError

An error encountered while executing a work request.

Attributes

code[RW]

[Required] A machine-usable code for the error that occured. Error codes are listed in [API Errors](docs.cloud.oracle.com/Content/API/References/apierrors.htm). @return [String]

message[RW]

[Required] A human readable description of the issue encountered. @return [String]

timestamp[RW]

[Required] Time the error occured. Format defined by [RFC3339](datatracker.ietf.org/doc/html/rfc3339). @return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/devops/models/work_request_error.rb, line 24
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'code',
    'message': :'message',
    'timestamp': :'timestamp'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :code The value to assign to the {#code} property @option attributes [String] :message The value to assign to the {#message} property @option attributes [DateTime] :timestamp The value to assign to the {#timestamp} property

# File lib/oci/devops/models/work_request_error.rb, line 54
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/devops/models/work_request_error.rb, line 35
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'String',
    'message': :'String',
    'timestamp': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/devops/models/work_request_error.rb, line 74
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/devops/models/work_request_error.rb, line 106
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/devops/models/work_request_error.rb, line 86
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/devops/models/work_request_error.rb, line 95
def hash
  [code, message, timestamp].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/devops/models/work_request_error.rb, line 139
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_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/devops/models/work_request_error.rb, line 133
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/devops/models/work_request_error.rb, line 156
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