1Search::Elasticsearch::UEsrerrorC(o3n)tributed Perl DocuSmeeanrtcaht:i:oEnlasticsearch::Error(3)
2
3
4

NAME

6       Search::Elasticsearch::Error - Errors thrown by Search::Elasticsearch
7

VERSION

9       version 7.30
10

DESCRIPTION

12       Errors thrown by Search::Elasticsearch are error objects, which can
13       include a stack trace and information to help debug problems. An error
14       object consists of the following:
15
16           {
17               type  => $type,              # eg Missing
18               text  => 'Error message',
19               vars  => {...},              # vars which may help to explain the error
20               stack => [...],              # a stack trace
21           }
22
23       The $Search::Elasticsearch::Error::DEBUG variable can be set to 1 or 2
24       to increase the verbosity of errors.
25
26       Error objects stringify to a human readable error message when used in
27       text context (for example: "print 'Oh no! '.$error").  They also
28       support the "TO_JSON" method to support conversion to JSON when
29       "convert_blessed" in JSON is enabled.
30

ERROR CLASSES

32       The following error classes are defined:
33
34       •   "Search::Elasticsearch::Error::Param"
35
36           A bad parameter has been passed to a method.
37
38       •   "Search::Elasticsearch::Error::Request"
39
40           There was some generic error performing your request in
41           Elasticsearch.  This error is triggered by HTTP status codes 400
42           and 500. This class has the following sub-classes:
43
44           •   "Search::Elasticsearch::Error::Unauthorized"
45
46               Invalid (or no) username/password provided as "userinfo" for a
47               password protected service. These errors are triggered by the
48               401 HTTP status code.
49
50           •   "Search::Elasticsearch::Error::Missing"
51
52               A resource that you requested was not found.  These errors are
53               triggered by the 404 HTTP status code.
54
55           •   "Elastisearch::Error::Conflict"
56
57               Your request could not be performed because of some conflict.
58               For instance, if you try to delete a document with a particular
59               version number, and the document has already changed, it will
60               throw a "Conflict" error.  If it can, it will include the
61               "current_version" in the error vars. This error is triggered by
62               the 409 HTTP status code.
63
64           •   "Search::Elasticsearch::Error::ContentLength"
65
66               The request body was longer than the max_content_length.
67
68           •   "Search::Elasticsearch::Error::RequestTimeout"
69
70               The request took longer than the specified "timeout".
71               Currently only applies to the cluster_health request.
72
73       •   "Search::Elasticsearch::Error::Timeout"
74
75           The request timed out.
76
77       •   "Search::Elasticsearch::Error::Cxn"
78
79           There was an error connecting to a node in the cluster.  This error
80           indicates node failure and will be retried on another node.  This
81           error has the following sub-classes:
82
83           •   "Search::Elasticsearch::Error::Unavailable"
84
85               The current node is unable to handle your request at the
86               moment. Your request will be retried on another node.  This
87               error is triggered by the 503 HTTP status code.
88
89           •   "Search::Elasticsearch::Error::BadGateway"
90
91               A proxy between the client and Elasticsearch is unable to
92               connect to Elasticsearch.  This error is triggered by the 502
93               HTTP status code.
94
95           •   "Search::Elasticsearch::Error::GatewayTimeout"
96
97               A proxy between the client and Elasticsearch is unable to
98               connect to Elasticsearch within its own timeout. This error is
99               triggered by the 504 HTTP status code.
100
101           •   "Search::Elasticsearch::Error::SSL"
102
103               There was a problem validating the SSL certificate.  Not all
104               backends support this error type.
105
106       •   "Search::Elasticsearch::Error::Forbidden"
107
108           Either the cluster was unable to process the request because it is
109           currently blocking, eg there are not enough master nodes to form a
110           cluster, or because the authenticated user is trying to perform an
111           unauthorized action. This error is triggered by the 403 HTTP status
112           code.
113
114       •   "Search::Elasticsearch::Error::Illegal"
115
116           You have attempted to perform an illegal operation.  For instance,
117           you attempted to use a Scroll helper in a different process after
118           forking.
119
120       •   "Search::Elasticsearch::Error::Serializer"
121
122           There was an error serializing a variable or deserializing a
123           string.
124
125       •   "Elasticsarch::Error::Internal"
126
127           An internal error occurred - please report this as a bug in this
128           module.
129

AUTHOR

131       Enrico Zimuel <enrico.zimuel@elastic.co>
132

134       This software is Copyright (c) 2020 by Elasticsearch BV.
135
136       This is free software, licensed under:
137
138         The Apache License, Version 2.0, January 2004
139
140
141
142perl v5.32.1                      2021-01-27   Search::Elasticsearch::Error(3)
Impressum