Class: Azure::CognitiveServices::ImageSearch::V1_0::Models::Error

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

Overview

Defines the error that occurred.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#code ⇒ ErrorCode

error. Possible values include: ‘None’, ‘ServerError’, ‘InvalidRequest’, ‘RateLimitExceeded’, ‘InvalidAuthorization’, ‘InsufficientAuthorization’. Default value: ‘None’ .

Returns:

  • (ErrorCode) —

    The error code that identifies the category of



19
20
21
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 19

def code
  @code
end

#message ⇒ String

Returns A description of the error.

Returns:

  • (String) —

    A description of the error.



30
31
32
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 30

def message
  @message
end

#more_details ⇒ String

about the error.

Returns:

  • (String) —

    A description that provides additional information



34
35
36
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 34

def more_details
  @more_details
end

#parameter ⇒ String

Returns The parameter in the request that caused the error.

Returns:

  • (String) —

    The parameter in the request that caused the error.



37
38
39
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 37

def parameter
  @parameter
end

#sub_code ⇒ ErrorSubCode

the error. Possible values include: ‘UnexpectedError’, ‘ResourceError’, ‘NotImplemented’, ‘ParameterMissing’, ‘ParameterInvalidValue’, ‘HttpNotAllowed’, ‘Blocked’, ‘AuthorizationMissing’, ‘AuthorizationRedundancy’, ‘AuthorizationDisabled’, ‘AuthorizationExpired’

Returns:

  • (ErrorSubCode) —

    The error code that further helps to identify



27
28
29
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 27

def sub_code
  @sub_code
end

#value ⇒ String

valid.

Returns:

  • (String) —

    The parameter’s value in the request that was not



41
42
43
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 41

def value
  @value
end

Class Method Details

.mapper ⇒ Object

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



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
106
107
108
109
110
111
112
113
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/error.rb', line 48

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',
          default_value: 'None',
          type: {
            name: 'String'
          }
        },
        sub_code: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'subCode',
          type: {
            name: 'String'
          }
        },
        message: {
          client_side_validation: true,
          required: true,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        },
        more_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'moreDetails',
          type: {
            name: 'String'
          }
        },
        parameter: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'parameter',
          type: {
            name: 'String'
          }
        },
        value: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'value',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end