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

Class StartStreaming.StartStreamingBuilder

  • Enclosing class:
    StartStreaming
    @NotThreadSafe
public static final class StartStreaming.StartStreamingBuilder
extends Object
    A mutable builder with a fluent API for creating an instance of StartStreaming.

    • Method Detail

      • withNamespaces

        public StartStreaming.StartStreamingBuilder withNamespaces​(@Nullable
                                                           Collection<String> namespaces)
        Sets the namespaces for which the filter should be applied.
        Parameters:
        namespaces - the namespaces for which the filter should be applied – if empty or null, all namespaces are considered.
        Returns:
        this builder instance to allow method chaining.

      • withFilter

        public StartStreaming.StartStreamingBuilder withFilter​(@Nullable
                                                       CharSequence filter)
        Sets the filter to be applied to events.
        Parameters:
        filter - the filter string (RQL) to apply for event filtering or null if none should be applied.
        Returns:
        this builder instance to allow method chaining.

      • withExtraFields

        public StartStreaming.StartStreamingBuilder withExtraFields​(@Nullable
                                                            org.eclipse.ditto.json.JsonFieldSelector extraFields)
        Determines the extra fields and their values to be additionally set to outgoing signals.
        Parameters:
        extraFields - selector for the extra fields or null if outgoing signals should not be enriched.
        Returns:
        this builder instance to allow method chaining.

      • withCorrelationId

        public StartStreaming.StartStreamingBuilder withCorrelationId​(@Nullable
                                                              CharSequence correlationId)
        Determines the correlation-id of the request.
        Parameters:
        correlationId - the correlationId read from the parameters.
        Returns:
        this builder instance to allow method chaining.

      • build

        public StartStreaming build()
        Builds an instance of StartStreaming with the properties of this builder.
        Returns:
        the StartStreaming instance.