io.elastic.api

Class Message

java.lang.Object

io.elastic.api.Message

All Implemented Interfaces:

java.io.Serializable

public class Message
extends java.lang.Object
implements java.io.Serializable

Message to be processed by a Function. A message may have a body, which represents a message's payload to be processed, and multiple attachments. Both body and attachments are JsonObjects.

A Function may retrieve a value from Message's body by a name, as shown in the following example.

 
    JsonArray orders = message.getBody().getJsonArray("orders");
 
 

A message is build using Message.Builder, as shown in the following example.

 
    JsonArray orders = JSON.parseArray(response.getOrders());

    JsonObject body = Json.createObjectBuilder()
            .add("orders", orders)
            .build();

    Message message = new Message.Builder().body(body).build();
 
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder Used to build Message instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_ATTACHMENTS
static java.lang.String	PROPERTY_BODY
static java.lang.String	PROPERTY_HEADERS
static java.lang.String	PROPERTY_ID
static java.lang.String	PROPERTY_METHOD
static java.lang.String	PROPERTY_ORIGINAL_URL
static java.lang.String	PROPERTY_PASSTHROUGH
static java.lang.String	PROPERTY_QUERY
static java.lang.String	PROPERTY_URL

Method Summary

Modifier and Type	Method and Description
jakarta.json.JsonObject	getAttachments() Returns message attachments.
jakarta.json.JsonObject	getBody() Returns message body.
jakarta.json.JsonObject	getHeaders() Returns message headers.
java.util.UUID	getId() Returns message id.
java.lang.String	getMethod() Returns message method.
java.lang.String	getOriginalUrl() Returns message originalUrl.
jakarta.json.JsonObject	getPassthrough() Returns message passthrough.
jakarta.json.JsonObject	getQuery() Returns message query object.
java.lang.String	getUrl() Returns message URL.
jakarta.json.JsonObject	toJsonObject() Returns this message as JsonObject.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_ID

public static final java.lang.String PROPERTY_ID

See Also:

Constant Field Values

PROPERTY_ATTACHMENTS

public static final java.lang.String PROPERTY_ATTACHMENTS

See Also:

Constant Field Values

PROPERTY_BODY

public static final java.lang.String PROPERTY_BODY

See Also:

Constant Field Values

PROPERTY_HEADERS

public static final java.lang.String PROPERTY_HEADERS

See Also:

Constant Field Values

PROPERTY_METHOD

public static final java.lang.String PROPERTY_METHOD

See Also:

Constant Field Values

PROPERTY_ORIGINAL_URL

public static final java.lang.String PROPERTY_ORIGINAL_URL

See Also:

Constant Field Values

PROPERTY_QUERY

public static final java.lang.String PROPERTY_QUERY

See Also:

Constant Field Values

PROPERTY_PASSTHROUGH

public static final java.lang.String PROPERTY_PASSTHROUGH

See Also:

Constant Field Values

PROPERTY_URL

public static final java.lang.String PROPERTY_URL

See Also:

Constant Field Values

Method Detail

getId

public java.util.UUID getId()

Returns message id.

Returns:

id

getAttachments

public jakarta.json.JsonObject getAttachments()

Returns message attachments.

Returns:

attachments

getBody

public jakarta.json.JsonObject getBody()

Returns message body.

Returns:

body

getHeaders

public jakarta.json.JsonObject getHeaders()

Returns message headers.

Returns:

headers

getMethod

public java.lang.String getMethod()

Returns message method.

Returns:

method

getOriginalUrl

public java.lang.String getOriginalUrl()

Returns message originalUrl.

Returns:

originalUrl

getQuery

public jakarta.json.JsonObject getQuery()

Returns message query object.

Returns:

query

getPassthrough

public jakarta.json.JsonObject getPassthrough()

Returns message passthrough.

Returns:

passthrough

getUrl

public java.lang.String getUrl()

Returns message URL.

Returns:

url

toJsonObject

public jakarta.json.JsonObject toJsonObject()

Returns this message as JsonObject.

Returns:

message as JSON object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object