Package org.elasticsearch.rest

Enum Class RestStatus

java.lang.Object

java.lang.Enum<RestStatus>

org.elasticsearch.rest.RestStatus

All Implemented Interfaces:

Serializable, Comparable<RestStatus>, Constable

public enum RestStatus
extends Enum<RestStatus>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCEPTED	The request has been accepted for processing, but the processing has not been completed.
BAD_GATEWAY	The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.
BAD_REQUEST	The request could not be understood by the server due to malformed syntax.
CONFLICT	The request could not be completed due to a conflict with the current state of the resource.
CONTINUE	The client SHOULD continue with its request.
CREATED	The request has been fulfilled and resulted in a new resource being created.
EXPECTATION_FAILED	The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server.
FAILED_DEPENDENCY	The 424 (Failed Dependency) status code means that the method could not be performed on the resource because the requested action depended on another action and that action failed.
FORBIDDEN	The server understood the request, but is refusing to fulfill it.
FOUND	The requested resource resides temporarily under a different URI.
GATEWAY_TIMEOUT	The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g.
GONE	The requested resource is no longer available at the server and no forwarding address is known.
HTTP_VERSION_NOT_SUPPORTED	The server does not support, or refuses to support, the HTTP protocol version that was used in the request message.
INSUFFICIENT_STORAGE	The 507 (Insufficient Storage) status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
INTERNAL_SERVER_ERROR	The server encountered an unexpected condition which prevented it from fulfilling the request.
LENGTH_REQUIRED	The server refuses to accept the request without a defined Content-Length.
LOCKED	The 423 (Locked) status code means the source or destination resource of a method is locked.
METHOD_NOT_ALLOWED	The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
MOVED_PERMANENTLY	The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs.
MULTI_STATUS	The 207 (Multi-Status) status code provides status for multiple independent operations (see Section 13 for more information).
MULTIPLE_CHOICES	The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent-driven negotiation information (section 12) is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location.
NO_CONTENT	The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta information.
NON_AUTHORITATIVE_INFORMATION	The returned meta information in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy.
NOT_ACCEPTABLE	The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
NOT_FOUND	The server has not found anything matching the Request-URI.
NOT_IMPLEMENTED	The server does not support the functionality required to fulfill the request.
NOT_MODIFIED	If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code.
OK	The request has succeeded.
PARTIAL_CONTENT	The server has fulfilled the partial GET request for the resource.
PAYMENT_REQUIRED	This code is reserved for future use.
PRECONDITION_FAILED	The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.
PROXY_AUTHENTICATION	This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy.
REQUEST_ENTITY_TOO_LARGE	The server is refusing to process a request because the request entity is larger than the server is willing or able to process.
REQUEST_TIMEOUT	The client did not produce a request within the time that the server was prepared to wait.
REQUEST_URI_TOO_LONG	The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.
REQUESTED_RANGE_NOT_SATISFIED	A server SHOULD return a response with this status code if a request included a Range request-header field (section 14.35), and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field.
RESET_CONTENT	The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent.
SEE_OTHER	The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource.
SERVICE_UNAVAILABLE	The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
SWITCHING_PROTOCOLS	The server understands and is willing to comply with the client's request, via the Upgrade message header field (section 14.42), for a change in the application protocol being used on this connection.
TEMPORARY_REDIRECT	The requested resource resides temporarily under a different URI.
TOO_MANY_REQUESTS	429 Too Many Requests (RFC6585)
UNAUTHORIZED	The request requires user authentication.
UNPROCESSABLE_ENTITY	The 422 (Unprocessable Entity) status code means the server understands the content type of the request entity (hence a 415(Unsupported Media Type) status code is inappropriate), and the syntax of the request entity is correct (thus a 400 (Bad Request) status code is inappropriate) but was unable to process the contained instructions.
UNSUPPORTED_MEDIA_TYPE	The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
USE_PROXY	The requested resource MUST be accessed through the proxy given by the Location field.

Method Summary

Modifier and Type	Method	Description
static RestStatus	fromCode(int code)	Turn a status code into a RestStatus, returning null if we don't know that status.
int	getStatus()
static RestStatus	readFrom(StreamInput in)
static RestStatus	status(int successfulShards, int totalShards, ShardOperationFailedException... failures)
static RestStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RestStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static void	writeTo(StreamOutput out, RestStatus status)

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTINUE

public static final RestStatus CONTINUE

The client SHOULD continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response. The server MUST send a final response after the request has been completed.

SWITCHING_PROTOCOLS

public static final RestStatus SWITCHING_PROTOCOLS

The server understands and is willing to comply with the client's request, via the Upgrade message header field (section 14.42), for a change in the application protocol being used on this connection. The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response.

OK

public static final RestStatus OK

The request has succeeded. The information returned with the response is dependent on the method used in the request, for example:

• GET: an entity corresponding to the requested resource is sent in the response;
• HEAD: the entity-header fields corresponding to the requested resource are sent in the response without any message-body;
• POST: an entity describing or containing the result of the action;
• TRACE: an entity containing the request message as received by the end server.

CREATED

public static final RestStatus CREATED

The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code. If the action cannot be carried out immediately, the server SHOULD respond with 202 (Accepted) response instead.

A 201 response MAY contain an ETag response header field indicating the current value of the entity tag for the requested variant just created, see section 14.19.

ACCEPTED

public static final RestStatus ACCEPTED

The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this.

The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled.

NON_AUTHORITATIVE_INFORMATION

public static final RestStatus NON_AUTHORITATIVE_INFORMATION

The returned meta information in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy. The set presented MAY be a subset or super set of the original version. For example, including local annotation information about the resource might result in a super set of the meta information known by the origin server. Use of this response code is not required and is only appropriate when the response would otherwise be 200 (OK).

NO_CONTENT

public static final RestStatus NO_CONTENT

The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta information. The response MAY include new or updated meta information in the form of entity-headers, which if present SHOULD be associated with the requested variant.

If the client is a user agent, it SHOULD NOT change its document view from that which caused the request to be sent. This response is primarily intended to allow input for actions to take place without causing a change to the user agent's active document view, although any new or updated meta information SHOULD be applied to the document currently in the user agent's active view.

The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields.

RESET_CONTENT

public static final RestStatus RESET_CONTENT

The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent. This response is primarily intended to allow input for actions to take place via user input, followed by a clearing of the form in which the input is given so that the user can easily initiate another input action. The response MUST NOT include an entity.

PARTIAL_CONTENT

public static final RestStatus PARTIAL_CONTENT

The server has fulfilled the partial GET request for the resource. The request MUST have included a Range header field (section 14.35) indicating the desired range, and MAY have included an If-Range header field (section 14.27) to make the request conditional.

The response MUST include the following header fields:

• Either a Content-Range header field (section 14.16) indicating the range included with this response, or a multipart/byteranges Content-Type including Content-Range fields for each part. If a Content-Length header field is present in the response, its value MUST match the actual number of OCTETs transmitted in the message-body.
• Date
• ETag and/or Content-Location, if the header would have been sent in a 200 response to the same request
• Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous response for the same variant

If the 206 response is the result of an If-Range request that used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. If the response is the result of an If-Range request that used a weak validator, the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. Otherwise, the response MUST include all of the entity-headers that would have been returned with a 200 (OK) response to the same request.

A cache MUST NOT combine a 206 response with other previously cached content if the ETag or Last-Modified headers do not match exactly, see 13.5.4.

A cache that does not support the Range and Content-Range headers MUST NOT cache 206 (Partial) responses.

MULTI_STATUS

public static final RestStatus MULTI_STATUS

The 207 (Multi-Status) status code provides status for multiple independent operations (see Section 13 for more information).

A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate. The default Multi-Status response body is a text/xml or application/xml HTTP entity with a 'multistatus' root element. Further elements contain 200, 300, 400, and 500 series status codes generated during the method invocation. 100 series status codes SHOULD NOT be recorded in a 'response' XML element.

Although '207' is used as the overall response status code, the recipient needs to consult the contents of the multistatus response body for further information about the success or failure of the method execution. The response MAY be used in success, partial success and also in failure situations.

The 'multistatus' root element holds zero or more 'response' elements in any order, each with information about an individual resource. Each 'response' element MUST have an 'href' element to identify the resource.

MULTIPLE_CHOICES

public static final RestStatus MULTIPLE_CHOICES

The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent-driven negotiation information (section 12) is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location.

Unless it was a HEAD request, the response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.

If the server has a preferred choice of representation, it SHOULD include the specific URI for that representation in the Location field; user agents MAY use the Location field value for automatic redirection. This response is cacheable unless indicated otherwise.

MOVED_PERMANENTLY

public static final RestStatus MOVED_PERMANENTLY

The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs. Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible. This response is cacheable unless indicated otherwise.

The new permanent URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

FOUND

public static final RestStatus FOUND

The requested resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.

The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

If the 302 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

SEE_OTHER

public static final RestStatus SEE_OTHER

The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be cacheable.

The different URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

NOT_MODIFIED

public static final RestStatus NOT_MODIFIED

If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields.

The response MUST include the following header fields:

• Date, unless its omission is required by section 14.18.1 If a clockless origin server obeys these rules, and proxies and clients add their own Date to any response received without one (as already specified by [RFC 2068], section 14.19), caches will operate correctly.
• ETag and/or Content-Location, if the header would have been sent in a 200 response to the same request
• Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous response for the same variant

If the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. Otherwise (i.e., the conditional GET used a weak validator), the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers.

If a 304 response indicates an entity not currently cached, then the cache MUST disregard the response and repeat the request without the conditional.

If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to reflect any new field values given in the response.

USE_PROXY

public static final RestStatus USE_PROXY

The requested resource MUST be accessed through the proxy given by the Location field. The Location field gives the URI of the proxy. The recipient is expected to repeat this single request via the proxy. 305 responses MUST only be generated by origin servers.

TEMPORARY_REDIRECT

public static final RestStatus TEMPORARY_REDIRECT

The requested resource resides temporarily under a different URI. Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.

The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore, the note SHOULD contain the information necessary for a user to repeat the original request on the new URI.

If the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

BAD_REQUEST

public static final RestStatus BAD_REQUEST

The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

UNAUTHORIZED

public static final RestStatus UNAUTHORIZED

The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43].

PAYMENT_REQUIRED

public static final RestStatus PAYMENT_REQUIRED

This code is reserved for future use.

FORBIDDEN

public static final RestStatus FORBIDDEN

The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.

NOT_FOUND

public static final RestStatus NOT_FOUND

The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

METHOD_NOT_ALLOWED

public static final RestStatus METHOD_NOT_ALLOWED

The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response MUST include an Allow header containing a list of valid methods for the requested resource.

NOT_ACCEPTABLE

public static final RestStatus NOT_ACCEPTABLE

The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.

Note: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept headers sent in the request. In some cases, this may even be preferable to sending a 406 response. User agents are encouraged to inspect the headers of an incoming response to determine if it is acceptable.

If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions.

PROXY_AUTHENTICATION

public static final RestStatus PROXY_AUTHENTICATION

This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. The proxy MUST return a Proxy-Authenticate header field (section 14.33) containing a challenge applicable to the proxy for the requested resource. The client MAY repeat the request with a suitable Proxy-Authorization header field (section 14.34). HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43].

REQUEST_TIMEOUT

public static final RestStatus REQUEST_TIMEOUT

The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time.

CONFLICT

public static final RestStatus CONFLICT

The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD include enough information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required.

Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type.

GONE

public static final RestStatus GONE

The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise.

The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner.

LENGTH_REQUIRED

public static final RestStatus LENGTH_REQUIRED

The server refuses to accept the request without a defined Content-Length. The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message-body in the request message.

PRECONDITION_FAILED

public static final RestStatus PRECONDITION_FAILED

The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. This response code allows the client to place preconditions on the current resource metainformation (header field data) and thus prevent the requested method from being applied to a resource other than the one intended.

REQUEST_ENTITY_TOO_LARGE

public static final RestStatus REQUEST_ENTITY_TOO_LARGE

The server is refusing to process a request because the request entity is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request.

If the condition is temporary, the server SHOULD include a Retry-After header field to indicate that it is temporary and after what time the client MAY try again.

REQUEST_URI_TOO_LONG

public static final RestStatus REQUEST_URI_TOO_LONG

The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret. This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a URI "black hole" of redirection (e.g., a redirected URI prefix that points to a suffix of itself), or when the server is under attack by a client attempting to exploit security holes present in some servers using fixed-length buffers for reading or manipulating the Request-URI.

UNSUPPORTED_MEDIA_TYPE

public static final RestStatus UNSUPPORTED_MEDIA_TYPE

The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

REQUESTED_RANGE_NOT_SATISFIED

public static final RestStatus REQUESTED_RANGE_NOT_SATISFIED

A server SHOULD return a response with this status code if a request included a Range request-header field (section 14.35), and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this means that the first-byte-pos of all of the byte-range-spec values were greater than the current length of the selected resource.)

When this status code is returned for a byte-range request, the response SHOULD include a Content-Range entity-header field specifying the current length of the selected resource (see section 14.16). This response MUST NOT use the multipart/byteranges content-type.

EXPECTATION_FAILED

public static final RestStatus EXPECTATION_FAILED

The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server.

UNPROCESSABLE_ENTITY

public static final RestStatus UNPROCESSABLE_ENTITY

The 422 (Unprocessable Entity) status code means the server understands the content type of the request entity (hence a 415(Unsupported Media Type) status code is inappropriate), and the syntax of the request entity is correct (thus a 400 (Bad Request) status code is inappropriate) but was unable to process the contained instructions. For example, this error condition may occur if an XML request body contains well-formed (i.e., syntactically correct), but semantically erroneous, XML instructions.

LOCKED

public static final RestStatus LOCKED

The 423 (Locked) status code means the source or destination resource of a method is locked. This response SHOULD contain an appropriate precondition or postcondition code, such as 'lock-token-submitted' or 'no-conflicting-lock'.

FAILED_DEPENDENCY

public static final RestStatus FAILED_DEPENDENCY

The 424 (Failed Dependency) status code means that the method could not be performed on the resource because the requested action depended on another action and that action failed. For example, if a command in a PROPPATCH method fails, then, at minimum, the rest of the commands will also fail with 424 (Failed Dependency).

TOO_MANY_REQUESTS

public static final RestStatus TOO_MANY_REQUESTS

429 Too Many Requests (RFC6585)

INTERNAL_SERVER_ERROR

public static final RestStatus INTERNAL_SERVER_ERROR

The server encountered an unexpected condition which prevented it from fulfilling the request.

NOT_IMPLEMENTED

public static final RestStatus NOT_IMPLEMENTED

The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

BAD_GATEWAY

public static final RestStatus BAD_GATEWAY

The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

SERVICE_UNAVAILABLE

public static final RestStatus SERVICE_UNAVAILABLE

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response.

GATEWAY_TIMEOUT

public static final RestStatus GATEWAY_TIMEOUT

The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.

HTTP_VERSION_NOT_SUPPORTED

public static final RestStatus HTTP_VERSION_NOT_SUPPORTED

The server does not support, or refuses to support, the HTTP protocol version that was used in the request message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described in section 3.1, other than with this error message. The response SHOULD contain an entity describing why that version is not supported and what other protocols are supported by that server.

INSUFFICIENT_STORAGE

public static final RestStatus INSUFFICIENT_STORAGE

The 507 (Insufficient Storage) status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. This condition is considered to be temporary. If the request that received this status code was the result of a user action, the request MUST NOT be repeated until it is requested by a separate user action.

Method Details

values

public static RestStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RestStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getStatus

public int getStatus()

readFrom

public static RestStatus readFrom(StreamInput in)
                           throws IOException

Throws:

IOException

writeTo

public static void writeTo(StreamOutput out,
 RestStatus status)
                    throws IOException

Throws:

IOException

status

public static RestStatus status(int successfulShards,
 int totalShards,
 ShardOperationFailedException... failures)

fromCode

public static RestStatus fromCode(int code)

Turn a status code into a RestStatus, returning null if we don't know that status.