Class: Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::Error

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb

Overview

The error object. As per Microsoft One API guidelines - github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Direct Known Subclasses

ErrorResponseError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#code ⇒ ErrorCodeType

Possible values include: ‘BadArgument’, ‘Forbidden’, ‘NotFound’, ‘KbNotFound’, ‘Unauthorized’, ‘Unspecified’, ‘EndpointKeysError’, ‘QuotaExceeded’, ‘QnaRuntimeError’, ‘SKULimitExceeded’, ‘OperationNotFound’, ‘ServiceError’, ‘ValidationFailure’, ‘ExtractionFailure’

Returns:

  • (ErrorCodeType) —

    One of a server-defined set of error codes.



22
23
24
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb', line 22

def code
  @code
end

#details ⇒ Array<Error>

led to this reported error.

Returns:

  • (Array<Error>) —

    An array of details about specific errors that



32
33
34
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb', line 32

def details
  @details
end

#inner_error ⇒ InnerErrorModel

information than the current object about the error.

Returns:



36
37
38
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb', line 36

def inner_error
  @inner_error
end

#message ⇒ String

Returns A human-readable representation of the error.

Returns:

  • (String) —

    A human-readable representation of the error.



25
26
27
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb', line 25

def message
  @message
end

#target ⇒ String

Returns The target of the error.

Returns:

  • (String) —

    The target of the error.



28
29
30
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb', line 28

def target
  @target
end

Class Method Details

.mapper ⇒ Object

Mapper for Error class as Ruby Hash. This will be used for serialization/deserialization.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/error.rb', line 43

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Error',
    type: {
      name: 'Composite',
      class_name: 'Error',
      model_properties: {
        code: {
          client_side_validation: true,
          required: true,
          serialized_name: 'code',
          type: {
            name: 'String'
          }
        },
        message: {
          client_side_validation: true,
          required: false,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        },
        target: {
          client_side_validation: true,
          required: false,
          serialized_name: 'target',
          type: {
            name: 'String'
          }
        },
        details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'details',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ErrorElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Error'
                }
            }
          }
        },
        inner_error: {
          client_side_validation: true,
          required: false,
          serialized_name: 'innerError',
          type: {
            name: 'Composite',
            class_name: 'InnerErrorModel'
          }
        }
      }
    }
  }
end