org.streampipes.sdk.builder

Class DataStreamBuilder

java.lang.Object

org.streampipes.sdk.builder.AbstractPipelineElementBuilder<DataStreamBuilder,SpDataStream>

org.streampipes.sdk.builder.DataStreamBuilder

public class DataStreamBuilder
extends AbstractPipelineElementBuilder<DataStreamBuilder,SpDataStream>

Field Summary

Fields inherited from class org.streampipes.sdk.builder.AbstractPipelineElementBuilder

elementDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataStreamBuilder(String id, String label, String description)

Method Summary

Modifier and Type	Method and Description
static DataStreamBuilder	create(String id, String label, String description) Creates a new data stream using the builder pattern.
DataStreamBuilder	format(TransportFormat format) Assigns a new TransportFormat to the stream definition.
protected DataStreamBuilder	me()
protected void	prepareBuild()
DataStreamBuilder	properties(List<EventProperty> properties) Assigns a list of new event properties to the stream's schema.
DataStreamBuilder	property(EventProperty property) Assigns a new event property to the stream's schema.
DataStreamBuilder	protocol(TransportProtocol protocol) Assigns a new TransportProtocol to the stream definition.

Methods inherited from class org.streampipes.sdk.builder.AbstractPipelineElementBuilder

build, iconUrl, prepareStaticProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

DataStreamBuilder

protected DataStreamBuilder(String id,
                            String label,
                            String description)

Method Detail

create

public static DataStreamBuilder create(String id,
                                       String label,
                                       String description)

Creates a new data stream using the builder pattern.

Parameters:

id - A unique identifier of the new element, e.g., com.mycompany.stream.mynewdatastream

label - A human-readable name of the element. Will later be shown as the element name in the StreamPipes UI.

description - A human-readable description of the element.

Returns:

a new instance of DataStreamBuilder

property

public DataStreamBuilder property(EventProperty property)

Assigns a new event property to the stream's schema.

Parameters:

property - The event property that should be added. Use EpProperties for defining simple property definitions or PrimitivePropertyBuilder for defining more complex definitions.

Returns:

this

properties

public DataStreamBuilder properties(List<EventProperty> properties)

Assigns a list of new event properties to the stream's schema.

Parameters:

properties - The event properties that should be added.

Returns:

this

protocol

public DataStreamBuilder protocol(TransportProtocol protocol)

Assigns a new TransportProtocol to the stream definition.

Parameters:

protocol - The transport protocol of the stream at runtime (e.g., Kafka or MQTT). Use Protocols to use some pre-defined protocols (or create a new protocol as described in the developer guide).

Returns:

this

format

public DataStreamBuilder format(TransportFormat format)

Assigns a new TransportFormat to the stream definition.

Parameters:

format - The transport format of the stream at runtime (e.g., JSON or Thrift). Use Formats to use some pre-defined formats (or create a new format as described in the developer guide).

Returns:

this

me

protected DataStreamBuilder me()

Specified by:

me in class AbstractPipelineElementBuilder<DataStreamBuilder,SpDataStream>

prepareBuild

protected void prepareBuild()

Specified by:

prepareBuild in class AbstractPipelineElementBuilder<DataStreamBuilder,SpDataStream>