Package org.opensearch.rest

Class BytesRestResponse

java.lang.Object

org.opensearch.rest.RestResponse

org.opensearch.rest.BytesRestResponse

public class BytesRestResponse
extends RestResponse

REST response in bytes

Opensearch.api:

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEXT_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
BytesRestResponse(RestChannel channel, Exception e)
BytesRestResponse(RestChannel channel, RestStatus status, Exception e)
BytesRestResponse(RestStatus status, String content)	Creates a new plain text response.
BytesRestResponse(RestStatus status, String contentType, byte[] content)	Creates a binary response.
BytesRestResponse(RestStatus status, String contentType, String content)	Creates a new plain text response.
BytesRestResponse(RestStatus status, String contentType, BytesReference content)	Creates a binary response.
BytesRestResponse(RestStatus status, org.opensearch.common.xcontent.XContentBuilder builder)	Creates a new response based on XContentBuilder.

Method Summary

Modifier and Type	Method	Description
BytesReference	content()	The response content.
String	contentType()	The response content type.
static OpenSearchStatusException	errorFromXContent(org.opensearch.common.xcontent.XContentParser parser)
protected boolean	skipStackTrace()
RestStatus	status()	The rest status code.

Methods inherited from class org.opensearch.rest.RestResponse

addHeader, copyHeaders, getHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TEXT_CONTENT_TYPE

public static final String TEXT_CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

BytesRestResponse

public BytesRestResponse(RestStatus status,
 org.opensearch.common.xcontent.XContentBuilder builder)

Creates a new response based on XContentBuilder.

BytesRestResponse

public BytesRestResponse(RestStatus status,
 String content)

Creates a new plain text response.

BytesRestResponse

public BytesRestResponse(RestStatus status,
 String contentType,
 String content)

Creates a new plain text response.

BytesRestResponse

public BytesRestResponse(RestStatus status,
 String contentType,
 byte[] content)

Creates a binary response.

BytesRestResponse

public BytesRestResponse(RestStatus status,
 String contentType,
 BytesReference content)

Creates a binary response.

BytesRestResponse

public BytesRestResponse(RestChannel channel,
 Exception e)
                  throws IOException

Throws:

IOException

BytesRestResponse

public BytesRestResponse(RestChannel channel,
 RestStatus status,
 Exception e)
                  throws IOException

Throws:

IOException

Method Details

contentType

public String contentType()

Description copied from class: RestResponse

The response content type.

Specified by:

contentType in class RestResponse

content

public BytesReference content()

Description copied from class: RestResponse

The response content. Note, if the content is Releasable it should automatically be released when done by the channel sending it.

Specified by:

content in class RestResponse

status

public RestStatus status()

Description copied from class: RestResponse

The rest status code.

Specified by:

status in class RestResponse

skipStackTrace

protected boolean skipStackTrace()

errorFromXContent

public static OpenSearchStatusException errorFromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                                   throws IOException

Throws:

IOException