Transformation

Package:

flow.triggermesh.io/v1alpha1

flow.triggermesh.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the flow/v1alpha1 API group.

Resource Types:

DataWeaveTransformation
JQTransformation
Synchronizer
Transformation
XMLToJSONTransformation
XSLTTransformation

DataWeaveTransformation

DataWeaveTransformation is the Schema for an DataWeave transformation target.

Field Description

apiVersion
string flow.triggermesh.io/v1alpha1

kind
string DataWeaveTransformation

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
DataWeaveTransformationSpec

`dwSpell` ValueFromField	(Optional) DataWeave spell that will be used by default for transformation.
`allowPerEventDwSpell` bool	(Optional) Whether the default DwSpell can be overriden at each event
`inputContentType` string	(Optional) Content type for the incoming transformation.
`outputContentType` string	(Optional) Content type for transformation Output.
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

JQTransformation

Field Description

apiVersion
string flow.triggermesh.io/v1alpha1

kind
string JQTransformation

metadata
Kubernetes meta/v1.ObjectMeta (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
JQTransformationSpec

`query` string	The query that gets passed to the JQ library
`eventOptions` EventOptions	EventOptions for targets
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

Synchronizer

Synchronizer is the Schema for the Synchronizer target.

Field Description

apiVersion
string flow.triggermesh.io/v1alpha1

kind
string Synchronizer

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
SynchronizerSpec

`correlationKey` Correlation
`response` Response
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

Transformation

Transformation allows to declaratively perform data transformations on CloudEvents.

Field Description

apiVersion
string flow.triggermesh.io/v1alpha1

kind
string Transformation

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
TransformationSpec

`context` []Transform	Context contains Transformations that must be applied on CE Context
`data` []Transform	Data contains Transformations that must be applied on CE Data
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

XMLToJSONTransformation

XMLToJSONTransformation is the schema for the event transformer.

Field Description

apiVersion
string flow.triggermesh.io/v1alpha1

kind
string XMLToJSONTransformation

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
XMLToJSONTransformationSpec

eventOptions
EventOptions

EventOptions for targets

SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

Support sending to an event sink instead of replying.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides

(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

XSLTTransformation

XSLTTransformation is the Schema for an XSLT transformation target.

Field Description

apiVersion
string flow.triggermesh.io/v1alpha1

kind
string XSLTTransformation

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
XSLTTransformationSpec

`xslt` ValueFromField	(Optional) XSLT document that will be used by default for transformation. Can be omited if the XSLT is informed at each event.
`allowPerEventXSLT` bool	(Optional) Whether the default XSLT can be overriden at each event
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

Correlation

(Appears on: SynchronizerSpec)

Correlation holds the request-response matching parameters.

Field	Description
`attribute` string
`length` int

DataWeaveTransformationSpec

(Appears on: DataWeaveTransformation)

DataWeaveTransformationSpec defines the desired state of the component.

Field	Description
`dwSpell` ValueFromField	(Optional) DataWeave spell that will be used by default for transformation.
`allowPerEventDwSpell` bool	(Optional) Whether the default DwSpell can be overriden at each event
`inputContentType` string	(Optional) Content type for the incoming transformation.
`outputContentType` string	(Optional) Content type for transformation Output.
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

EventOptions

(Appears on: JQTransformationSpec, XMLToJSONTransformationSpec)

EventOptions modifies CloudEvents management at Targets.

Field Description

payloadPolicy
github.com/triggermesh/triggermesh/pkg/targets/adapter/cloudevents.PayloadPolicy

(Optional)

PayloadPolicy indicates if replies from the target should include a payload if available. Possible values are:

always: will return a with the reply payload if avaliable.
errors: will only reply with payload in case of an error.
never: will not reply with payload.

JQTransformationSpec

(Appears on: JQTransformation)

JQTransformationSpec defines the desired state of the component.

Field	Description
`query` string	The query that gets passed to the JQ library
`eventOptions` EventOptions	EventOptions for targets
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

Path

(Appears on: Transform)

Path is a key-value pair that represents JSON object path

Field	Description
`key` string
`value` string
`separator` string

Response

(Appears on: SynchronizerSpec)

Response defines the response handling configuration.

Field	Description
`timeout` github.com/triggermesh/triggermesh/pkg/apis.Duration

SynchronizerSpec

(Appears on: Synchronizer)

SynchronizerSpec defines the desired state of the component.

Field	Description
`correlationKey` Correlation
`response` Response
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

Transform

(Appears on: TransformationSpec)

Transform describes transformation schemes for different CE types.

Field	Description
`operation` string
`paths` []Path

TransformationSpec

(Appears on: Transformation)

TransformationSpec defines the desired state of the component.

Field	Description
`context` []Transform	Context contains Transformations that must be applied on CE Context
`data` []Transform	Data contains Transformations that must be applied on CE Data
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

ValueFromField

(Appears on: DataWeaveTransformationSpec, XSLTTransformationSpec)

ValueFromField is a struct field that can have its value either defined explicitly or sourced from another entity.

Field	Description
`value` string	(Optional) Field value.
`valueFromSecret` Kubernetes core/v1.SecretKeySelector	(Optional) Field value from a Kubernetes Secret.
`valueFromConfigMap` Kubernetes core/v1.ConfigMapKeySelector	(Optional) Field value from a Kubernetes ConfigMap.

XMLToJSONTransformationSpec

(Appears on: XMLToJSONTransformation)

XMLToJSONTransformationSpec defines the desired state of the component.

Field Description

eventOptions
EventOptions

EventOptions for targets

SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

Support sending to an event sink instead of replying.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides

(Optional)

Adapter spec overrides parameters.

XSLTTransformationSpec

(Appears on: XSLTTransformation)

XSLTTransformationSpec defines the desired state of the component.

Field	Description
`xslt` ValueFromField	(Optional) XSLT document that will be used by default for transformation. Can be omited if the XSLT is informed at each event.
`allowPerEventXSLT` bool	(Optional) Whether the default XSLT can be overriden at each event
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) Support sending to an event sink instead of replying.
`adapterOverrides` github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides	(Optional) Adapter spec overrides parameters.

Generated with gen-crd-api-reference-docs on git commit 419bda94.