class Azure::CognitiveServices::LocalSearch::V1_0::Models::Error

Defines the error that occurred.

Attributes

_type[RW]
code[RW]

@return [ErrorCode] The error code that identifies the category of error. Possible values include: 'None', 'ServerError', 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'. Default value: 'None' .

message[RW]

@return [String] A description of the error.

more_details[RW]

@return [String] A description that provides additional information about the error.

parameter[RW]

@return [String] The parameter in the request that caused the error.

sub_code[RW]

@return [ErrorSubCode] The error code that further helps to identify the error. Possible values include: 'UnexpectedError', 'ResourceError', 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue', 'HttpNotAllowed', 'Blocked', 'AuthorizationMissing', 'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired'

value[RW]

@return [String] The parameter's value in the request that was not valid.

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_localsearch/models/error.rb, line 56
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Error',
    type: {
      name: 'Composite',
      polymorphic_discriminator: '_type',
      uber_parent: 'Error',
      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
new() click to toggle source
# File lib/1.0/generated/azure_cognitiveservices_localsearch/models/error.rb, line 17
def initialize
  @_type = "Error"
end