Skip to main content

Models

This package is used to have available the models used by a Flowlyze Adapter.

The package ID is Ipaas.Adapter.Models.

For installation, remember to specify the local source of NuGet packages as per documentation.

To download the package click here.

Egress​

Currently, the only design constraint for an adapter occurs when you want to create an Egress-type flow. Egress are flows that are executed in output mode through which the flow is able to send data to an external system.

An egress is simply an endpoint that accepts incoming data, processes it, and returns a specific response.

In particular, the input requires an object of type EgressRequest<T> that contains data sent by Flowlyze to the adapter, and the output must return an object of type EgressResponse.

EgressRequest<T>​

The properties of this object are as follows:

  • Action: indicates the action to execute
  • RequestId: the request ID passed by Flowlyze
  • Messages: a list of messages of type MessageExecuteEnvelope<T>

MessageExecuteEnvelope<T>​

This class actually contains the data sent by Flowlyze with the addition of some fields for its identification.

In particular:

  • MsgId: the unique ID of the message
  • Msg: the data sent
  • Skip: a flag indicating whether the message should be skipped or not
  • Meta: an object of type Dictionary<string, object> that contains any message metadata

A GetValue() method that returns the object of type T of the message serialized from the Msg property that contains a generic object type.

EgressResponse​

This class represents the response that the adapter must return to Flowlyze.

It contains the following properties:

  • RequestId: the request ID
  • IsAsync: indicates if the message must be processed asynchronously
  • Messages: a list of objects of type MessageStatusEnvelope

MessageStatusEnvelope​

This class contains information about the response of a single message.

It contains the following properties:

  • Status: the message status
  • Date: the date when the message was processed
  • ErrorMessage: any error if the message was not processed correctly
  • Meta: an object of type Dictionary<string, object> that contains any message metadata