Package org.eclipse.ditto.services.gateway.streaming

Class StartStreaming

java.lang.Object

org.eclipse.ditto.services.gateway.streaming.StartStreaming

All Implemented Interfaces:

StreamControlMessage

public final class StartStreaming
extends Object
implements StreamControlMessage

Message indicating a demand to receive entities of a specified StreamingType via a "streaming" connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StartStreaming.StartStreamingBuilder	A mutable builder with a fluent API for creating an instance of StartStreaming.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
org.eclipse.ditto.model.base.auth.AuthorizationContext	getAuthorizationContext()
static StartStreaming.StartStreamingBuilder	getBuilder(StreamingType streamingType, CharSequence connectionCorrelationId, org.eclipse.ditto.model.base.auth.AuthorizationContext authorizationContext)	Returns a mutable builder with a fluent API for creating an instance of StartStreaming.
String	getConnectionCorrelationId()
Optional<org.eclipse.ditto.json.JsonFieldSelector>	getExtraFields()	Returns the selector for the extra fields and their values to enrich outgoing signals with.
Optional<String>	getFilter()
List<String>	getNamespaces()
StreamingType	getStreamingType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBuilder

public static StartStreaming.StartStreamingBuilder getBuilder(StreamingType streamingType,
                                                              CharSequence connectionCorrelationId,
                                                              org.eclipse.ditto.model.base.auth.AuthorizationContext authorizationContext)

Returns a mutable builder with a fluent API for creating an instance of StartStreaming.

Parameters:

streamingType - the type of entity to start the streaming for.

connectionCorrelationId - the correlationId of the connection/session.

authorizationContext - the AuthorizationContext of the connection/session.

Returns:

the builder.

Throws:

NullPointerException - if any argument is null.

getStreamingType

public StreamingType getStreamingType()

Returns:

the Streaming type of what streaming to start.

getConnectionCorrelationId

public String getConnectionCorrelationId()

getAuthorizationContext

public org.eclipse.ditto.model.base.auth.AuthorizationContext getAuthorizationContext()

getNamespaces

public List<String> getNamespaces()

Returns:

the List of namespaces for which Signals should be emitted to the stream

getFilter

public Optional<String> getFilter()

Returns:

the optional RQL filter to apply for events before publishing to the stream

getExtraFields

public Optional<org.eclipse.ditto.json.JsonFieldSelector> getExtraFields()

Returns the selector for the extra fields and their values to enrich outgoing signals with.

Returns:

the selector or an empty Optional if signals should not be enriched.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object