Class: TeamBattlesSdk::Generated::Models::Error

Inherits:
MicrosoftKiotaAbstractions::ApiError
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/teambattles_sdk/generated/models/error.rb

Overview

Standard API error response.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a error

Raises:

  • (StandardError)


23
24
25
26
# File 'lib/teambattles_sdk/generated/models/error.rb', line 23

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return Error.new
end

Instance Method Details

#detailsObject

Gets the details property value. Optional human-readable explanation. Often absent on auth/permission errors.

Returns:

  • a string



31
32
33
# File 'lib/teambattles_sdk/generated/models/error.rb', line 31

def details
    return @details
end

#details=(value) ⇒ Object

Sets the details property value. Optional human-readable explanation. Often absent on auth/permission errors.

Parameters:

  • value

    Value to set for the details property.

Returns:

  • a void



39
40
41
# File 'lib/teambattles_sdk/generated/models/error.rb', line 39

def details=(value)
    @details = value
end

#errorObject

Gets the error property value. Stable machine-readable error code (e.g. error_api_key_invalid). Treat this, not the message, as the programmatic contract.

Returns:

  • a string



46
47
48
# File 'lib/teambattles_sdk/generated/models/error.rb', line 46

def error
    return @error
end

#error=(value) ⇒ Object

Sets the error property value. Stable machine-readable error code (e.g. error_api_key_invalid). Treat this, not the message, as the programmatic contract.

Parameters:

  • value

    Value to set for the error property.

Returns:

  • a void



54
55
56
# File 'lib/teambattles_sdk/generated/models/error.rb', line 54

def error=(value)
    @error = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



61
62
63
64
65
66
# File 'lib/teambattles_sdk/generated/models/error.rb', line 61

def get_field_deserializers()
    return super.merge({
        "details" => lambda {|n| @details = n.get_string_value() },
        "error" => lambda {|n| @error = n.get_string_value() },
    })
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


72
73
74
75
76
77
# File 'lib/teambattles_sdk/generated/models/error.rb', line 72

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("details", @details)
    writer.write_string_value("error", @error)
end