dataobjects.adoc

Cheatsheets

ActionPayload

Name	Type	Description
@request	ActionRequest	-
@response	ActionResponse	-

ActionRequest

Name	Type	Description
@metadata	Json object	-
@source	String	-
@type	String	-

ActionResponse

Name	Type	Description
@error	ActionResponseError	-
@metadata	Json object	-
@success	Boolean	-

ActionResponseError

Name	Type	Description
@code	String	-
@message	String	-

CacheActionOptions

Name	Type	Description
@cache	Json object	-
@cacheKey	String	-
@failWhenLookupFails	Boolean	-
@failWhenStoreFails	Boolean	-
@logLevel	String	-
@payloadKey	String	-
@type	String	-

CircuitBreakerActionFactoryOptions

Name	Type	Description
@circuitBreakerName	String	Sets the circuit breaker name.
@circuitBreakerOptions	CircuitBreakerOptions	Sets the circuit breaker configuration options. Note that Knot.x enforce the fallback on error strategy.
@errorTransitions	Array of String	Sets error transitions.
@logLevel	String	Sets the action node log level.

EndpointOptions

Describes a physical details of HTTP service endpoint that Action will connect to.

---

Name	Type	Description
@additionalHeaders	Json object	Sets the additional request headers (and values) to be send in each request
@allowedRequestHeaders	Array of String	Sets the allowed requests headers that should be send to the service. The selected headers from the original client HTTP request are being send.
@body	String	Sets the request body schema to be sent to the endpoint. The body may contain Knot.x Server Common Placeholders referencing ClientRequest, Fragment's configuration or Fragment's payload, which will be interpolated if link flag is set. Please note that request body is sent only in case of using PUT, POST or PATCH HTTP method. This field is mutually exclusive with link.
@bodyJson	Json object	Sets the request body schema to be sent to the endpoint. The body may contain Knot.x Server Common Placeholders referencing ClientRequest, Fragment's configuration or Fragment's payload, which will be interpolated if link flag is set. Please note that request body is sent only in case of using PUT, POST or PATCH HTTP method. This field is mutually exclusive with link.
@clearUnmatchedPlaceholdersInBodyJson	Boolean	Configures interpolation of link parameter. When JSON body interpolation is enabled and this flag is set, placeholders not matched to a source will be replaced with an empty string. Please note that absent placeholders that are matched to a source (e.g. {payload.not-existent}) will always be replaced with an empty string.
@clearUnmatchedPlaceholdersInBodyString	Boolean	Configures interpolation of link parameter. When body interpolation is enabled and this flag is set, placeholders not matched to a source will be replaced with an empty string. Please note that absent placeholders that are matched to a source (e.g. {payload.not-existent}) will always be replaced with an empty string.
@clearUnmatchedPlaceholdersInPath	Boolean	Configures interpolation of link parameter. When path interpolation is enabled and this flag is set, placeholders not matched to a source will be replaced with an empty string. Please note that absent placeholders that are matched to a source (e.g. {payload.not-existent}) will always be replaced with an empty string.
@domain	String	Sets the domain of the external service
@encodePlaceholdersInBodyJson	Boolean	Configures interpolation of link parameter. When JSON body interpolation is enabled and this flag is set, values of matched placeholders will be encoded before interpolating. For details, see Knot.x Server Common Placeholders
@encodePlaceholdersInBodyString	Boolean	Configures interpolation of link parameter. When body interpolation is enabled and this flag is set, values of matched placeholders will be encoded before interpolating. For details, see Knot.x Server Common Placeholders
@encodePlaceholdersInPath	Boolean	Configures interpolation of link parameter. When path interpolation is enabled and this flag is set, values of matched placeholders will be encoded before interpolating. For details, see Knot.x Server Common Placeholders
@interpolateBody	Boolean	Configures interpolation of link parameter. When set, the body will be interpolated using Knot.x Server Common Placeholders referencing ClientRequest, Fragment's configuration or Fragment's payload.
@interpolatePath	Boolean	Configures interpolation of link parameter. When set, the path will be interpolated using Knot.x Server Common Placeholders referencing ClientRequest, Fragment's configuration or Fragment's payload.
@path	String	Sets the request path to the endpoint. The request path may contain Knot.x Server Common Placeholders referencing ClientRequest, Fragment's configuration or Fragment's payload.
@port	Number (int)	Sets the HTTP port the external service

HttpActionOptions

HTTP Action configuration

---

Name	Type	Description
@endpointOptions	EndpointOptions	Set the details of the remote http endpoint location.
@httpMethod	String	Set the HttpMethod used for performing the request. Defaults to GET. Supported methods are GET, POST, PATCH, PUT, DELETE and HEAD.
@logLevel	String	Set level of action logs.
@requestTimeoutMs	Number (long)	Configures the amount of time in milliseconds after which if the request does not return any data within, _timeout transition will be returned. Setting zero or a negative value disables the timeout. By default it is set to 0.
@responseOptions	ResponseOptions	-
@webClientOptions	WebClientOptions	Set the WebClientOptions used by the HTTP client to communicate with remote http endpoint. See https://vertx.io/docs/vertx-web-client/dataobjects.html#WebClientOptions for the details what can be configured.

ResponseOptions

Name	Type	Description
@forceJson	Boolean	Sets forceJson - it determines if response body should be parsed as json
@predicates	Array of String	Sets Vert.x response predicates