Sink

java.lang.Object
- akka.stream.scaladsl.Sink<In,Mat>

All Implemented Interfaces:

Graph<SinkShape<In>,Mat>
```
public final class Sink<In,Mat>
extends java.lang.Object
implements Graph<SinkShape<In>,Mat>
```
A Sink is a set of stream processing steps that has one open input. Can be used as a Subscriber

Constructor Summary

Constructors
Constructor and Description

Sink(StreamLayout.Module module)

Constructors
Constructor and Description
`Sink(StreamLayout.Module module)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Sink<T,NotUsed>`	`actorRef(ActorRef ref, java.lang.Object onCompleteMessage)` Sends the elements of the stream to the given `ActorRef`.
`static <T> Sink<T,NotUsed>`	`actorRefWithAck(ActorRef ref, java.lang.Object onInitMessage, java.lang.Object ackMessage, java.lang.Object onCompleteMessage, scala.Function1<java.lang.Throwable,java.lang.Object> onFailureMessage)` Sends the elements of the stream to the given `ActorRef` that sends back back-pressure signal.
`static <T> Sink<T,ActorRef>`	`actorSubscriber(Props props)` Creates a `Sink` that is materialized to an `ActorRef` which points to an Actor created according to the passed in `Props`.
`Sink<In,Mat>`	`addAttributes(Attributes attr)` Add the given attributes to this Sink.
`Sink<In,Mat>`	`asJava()` Converts this Scala DSL element to it's Java DSL counterpart.
`static <T> Sink<T,org.reactivestreams.Publisher<T>>`	`asPublisher(boolean fanout)` A `Sink` that materializes into a `Publisher`.
`Sink<In,Mat>`	`async()` Put an asynchronous boundary around this `Sink`
`static <T> Sink<T,NotUsed>`	`cancelled()` A `Sink` that immediately cancels its upstream after materialization.
`static <T,U> Sink<T,NotUsed>`	`combine(Sink<U,?> first, Sink<U,?> second, scala.collection.Seq<Sink<U,?>> rest, scala.Function1<java.lang.Object,Graph<UniformFanOutShape<T,U>,NotUsed>> strategy)` Combine several sinks with fan-out strategy like `Broadcast` or `Balance` and returns `Sink`.
`<In2> Sink<In2,Mat>`	`contramap(scala.Function1<In2,In> f)` Transform this Sink by applying a function to each incoming upstream element before it is passed to the `Sink`
`static <U,T> Sink<T,scala.concurrent.Future<U>>`	`fold(U zero, scala.Function2<U,T,U> f)` A `Sink` that will invoke the given function for every received element, giving it its previous output (or the given `zero` value) and the element as input.
`static <U,T> Sink<T,scala.concurrent.Future<U>>`	`foldAsync(U zero, scala.Function2<U,T,scala.concurrent.Future<U>> f)` A `Sink` that will invoke the given asynchronous function for every received element, giving it its previous output (or the given `zero` value) and the element as input.
`static <T> Sink<T,scala.concurrent.Future<Done>>`	`foreach(scala.Function1<T,scala.runtime.BoxedUnit> f)` A `Sink` that will invoke the given procedure for each received element.
`static <T> Sink<T,scala.concurrent.Future<Done>>`	`foreachParallel(int parallelism, scala.Function1<T,scala.runtime.BoxedUnit> f, scala.concurrent.ExecutionContext ec)` A `Sink` that will invoke the given function to each of the elements as they pass in.
`static <T,M> Sink<T,M>`	`fromGraph(Graph<SinkShape<T>,M> g)` A graph with the shape of a sink logically is a sink, this method makes it so also in type.
`static <T> Sink<T,NotUsed>`	`fromSubscriber(org.reactivestreams.Subscriber<T> subscriber)` Helper to create `Sink` from `Subscriber`.
`static <T> Sink<T,scala.concurrent.Future<T>>`	`head()` A `Sink` that materializes into a `Future` of the first value received.
`static <T> Sink<T,scala.concurrent.Future<scala.Option<T>>>`	`headOption()` A `Sink` that materializes into a `Future` of the optional first value received.
`static Sink<java.lang.Object,scala.concurrent.Future<Done>>`	`ignore()` A `Sink` that will consume the stream and discard the elements.
`static <T> Sink<T,scala.concurrent.Future<T>>`	`last()` A `Sink` that materializes into a `Future` of the last value received.
`static <T> Sink<T,scala.concurrent.Future<scala.Option<T>>>`	`lastOption()` A `Sink` that materializes into a `Future` of the optional last value received.
`static <T,M> Sink<T,scala.concurrent.Future<M>>`	`lazyInit(scala.Function1<T,scala.concurrent.Future<Sink<T,M>>> sinkFactory, scala.Function0<M> fallback)` Creates a real `Sink` upon receiving the first element.
`<Mat2> Sink<In,Mat2>`	`mapMaterializedValue(scala.Function1<Mat,Mat2> f)` Transform only the materialized value of this Sink, leaving all other properties as they were.
`StreamLayout.Module`	`module()` INTERNAL API.
`Sink<In,Mat>`	`named(java.lang.String name)` Add a name attribute to this Sink.
`static <T> Sink<T,NotUsed>`	`onComplete(scala.Function1<scala.util.Try<Done>,scala.runtime.BoxedUnit> callback)` A `Sink` that when the flow is completed, either through a failure or normal completion, apply the provided function with `Success` or `Failure`.
`static <T> Sink<T,SinkQueueWithCancel<T>>`	`queue()` Creates a `Sink` that is materialized as an `SinkQueue`.
`static <T> Sink<T,scala.concurrent.Future<T>>`	`reduce(scala.Function2<T,T,T> f)` A `Sink` that will invoke the given function for every received element, giving it its previous output (from the second element) and the element as input.
`<Mat2> Mat2`	`runWith(Graph<SourceShape<In>,Mat2> source, Materializer materializer)` Connect this `Sink` to a `Source` and run it.
`static <T> Sink<T,scala.concurrent.Future<scala.collection.immutable.Seq<T>>>`	`seq()` A `Sink` that keeps on collecting incoming elements until upstream terminates.
`SinkShape<In>`	`shape()` The shape of a graph is all that is externally visible: its inlets and outlets.
`java.lang.String`	`toString()`
`Sink<In,Mat>`	`withAttributes(Attributes attr)` Change the attributes of this `Sink` to the given ones and seal the list of attributes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Sink
```
public Sink(StreamLayout.Module module)
```
- Method Detail
  - fromGraph
```
public static <T,M> Sink<T,M> fromGraph(Graph<SinkShape<T>,M> g)
```
    A graph with the shape of a sink logically is a sink, this method makes it so also in type.
    
    Parameters:
    
    g - (undocumented)
    
    Returns:
    
    (undocumented)
  - fromSubscriber
```
public static <T> Sink<T,NotUsed> fromSubscriber(org.reactivestreams.Subscriber<T> subscriber)
```
    Helper to create Sink from Subscriber.
    
    Parameters:
    
    subscriber - (undocumented)
    
    Returns:
    
    (undocumented)
  - cancelled
```
public static <T> Sink<T,NotUsed> cancelled()
```
    A Sink that immediately cancels its upstream after materialization.
    
    Returns:
    
    (undocumented)
  - head
```
public static <T> Sink<T,scala.concurrent.Future<T>> head()
```
    A Sink that materializes into a Future of the first value received. If the stream completes before signaling at least a single element, the Future will be failed with a NoSuchElementException. If the stream signals an error errors before signaling at least a single element, the Future will be failed with the streams exception.
    See also headOption.
    
    Returns:
    
    (undocumented)
  - headOption
```
public static <T> Sink<T,scala.concurrent.Future<scala.Option<T>>> headOption()
```
    A Sink that materializes into a Future of the optional first value received. If the stream completes before signaling at least a single element, the value of the Future will be None. If the stream signals an error errors before signaling at least a single element, the Future will be failed with the streams exception.
    See also head.
    
    Returns:
    
    (undocumented)
  - last
```
public static <T> Sink<T,scala.concurrent.Future<T>> last()
```
    A Sink that materializes into a Future of the last value received. If the stream completes before signaling at least a single element, the Future will be failed with a NoSuchElementException. If the stream signals an error errors before signaling at least a single element, the Future will be failed with the streams exception.
    See also lastOption.
    
    Returns:
    
    (undocumented)
  - lastOption
```
public static <T> Sink<T,scala.concurrent.Future<scala.Option<T>>> lastOption()
```
    A Sink that materializes into a Future of the optional last value received. If the stream completes before signaling at least a single element, the value of the Future will be None. If the stream signals an error errors before signaling at least a single element, the Future will be failed with the streams exception.
    See also last.
    
    Returns:
    
    (undocumented)
  - seq
```
public static <T> Sink<T,scala.concurrent.Future<scala.collection.immutable.Seq<T>>> seq()
```
    A Sink that keeps on collecting incoming elements until upstream terminates. As upstream may be unbounded, Flow[T].take or the stricter Flow[T].limit (and their variants) may be used to ensure boundedness. Materializes into a Future of Seq[T] containing all the collected elements. Seq is limited to Int.MaxValue elements, this Sink will cancel the stream after having received that many elements.
    See also Flow.limit, Flow.limitWeighted, Flow.take, Flow.takeWithin, Flow.takeWhile
    
    Returns:
    
    (undocumented)
  - asPublisher
```
public static <T> Sink<T,org.reactivestreams.Publisher<T>> asPublisher(boolean fanout)
```
    A Sink that materializes into a Publisher.
    If fanout is true, the materialized Publisher will support multiple Subscribers and the size of the inputBuffer configured for this stage becomes the maximum number of elements that the fastest Subscriber can be ahead of the slowest one before slowing the processing down due to back pressure.
    If fanout is false then the materialized Publisher will only support a single Subscriber and reject any additional Subscribers.
    
    Parameters:
    
    fanout - (undocumented)
    
    Returns:
    
    (undocumented)
  - ignore
```
public static Sink<java.lang.Object,scala.concurrent.Future<Done>> ignore()
```
    A Sink that will consume the stream and discard the elements.
    
    Returns:
    
    (undocumented)
  - foreach
```
public static <T> Sink<T,scala.concurrent.Future<Done>> foreach(scala.Function1<T,scala.runtime.BoxedUnit> f)
```
    A Sink that will invoke the given procedure for each received element. The sink is materialized into a Future will be completed with Success when reaching the normal end of the stream, or completed with Failure if there is a failure signaled in the stream..
    
    Parameters:
    
    f - (undocumented)
    
    Returns:
    
    (undocumented)
  - combine
```
public static <T,U> Sink<T,NotUsed> combine(Sink<U,?> first,
                                            Sink<U,?> second,
                                            scala.collection.Seq<Sink<U,?>> rest,
                                            scala.Function1<java.lang.Object,Graph<UniformFanOutShape<T,U>,NotUsed>> strategy)
```
    Combine several sinks with fan-out strategy like Broadcast or Balance and returns Sink.
    
    Parameters:
    
    first - (undocumented)
    
    second - (undocumented)
    
    rest - (undocumented)
    
    strategy - (undocumented)
    
    Returns:
    
    (undocumented)
  - foreachParallel
```
public static <T> Sink<T,scala.concurrent.Future<Done>> foreachParallel(int parallelism,
                                                                        scala.Function1<T,scala.runtime.BoxedUnit> f,
                                                                        scala.concurrent.ExecutionContext ec)
```
    A Sink that will invoke the given function to each of the elements as they pass in. The sink is materialized into a Future
    If f throws an exception and the supervision decision is akka.stream.Supervision.Stop the Future will be completed with failure.
    If f throws an exception and the supervision decision is akka.stream.Supervision.Resume or akka.stream.Supervision.Restart the element is dropped and the stream continues.
    See also Flow.mapAsyncUnordered
    
    Parameters:
    
    parallelism - (undocumented)
    
    f - (undocumented)
    
    ec - (undocumented)
    
    Returns:
    
    (undocumented)
  - fold
```
public static <U,T> Sink<T,scala.concurrent.Future<U>> fold(U zero,
                                                            scala.Function2<U,T,U> f)
```
    A Sink that will invoke the given function for every received element, giving it its previous output (or the given zero value) and the element as input. The returned Future will be completed with value of the final function evaluation when the input stream ends, or completed with Failure if there is a failure signaled in the stream.
    
    Parameters:
    
    zero - (undocumented)
    
    f - (undocumented)
    
    Returns:
    
    (undocumented)
    
    See Also:
    
    foldAsync(U, scala.Function2<U, T, scala.concurrent.Future<U>>)
  - foldAsync
```
public static <U,T> Sink<T,scala.concurrent.Future<U>> foldAsync(U zero,
                                                                 scala.Function2<U,T,scala.concurrent.Future<U>> f)
```
    A Sink that will invoke the given asynchronous function for every received element, giving it its previous output (or the given zero value) and the element as input. The returned Future will be completed with value of the final function evaluation when the input stream ends, or completed with Failure if there is a failure signaled in the stream.
    
    Parameters:
    
    zero - (undocumented)
    
    f - (undocumented)
    
    Returns:
    
    (undocumented)
    
    See Also:
    
    fold(U, scala.Function2<U, T, U>)
  - reduce
```
public static <T> Sink<T,scala.concurrent.Future<T>> reduce(scala.Function2<T,T,T> f)
```
    A Sink that will invoke the given function for every received element, giving it its previous output (from the second element) and the element as input. The returned Future will be completed with value of the final function evaluation when the input stream ends, or completed with Failure if there is a failure signaled in the stream.
    If the stream is empty (i.e. completes before signalling any elements), the reduce stage will fail its downstream with a NoSuchElementException, which is semantically in-line with that Scala's standard library collections do in such situations.
    
    Parameters:
    
    f - (undocumented)
    
    Returns:
    
    (undocumented)
  - onComplete
```
public static <T> Sink<T,NotUsed> onComplete(scala.Function1<scala.util.Try<Done>,scala.runtime.BoxedUnit> callback)
```
    A Sink that when the flow is completed, either through a failure or normal completion, apply the provided function with Success or Failure.
    
    Parameters:
    
    callback - (undocumented)
    
    Returns:
    
    (undocumented)
  - actorRef
```
public static <T> Sink<T,NotUsed> actorRef(ActorRef ref,
                                           java.lang.Object onCompleteMessage)
```
    Sends the elements of the stream to the given ActorRef. If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure a Status.Failure message will be sent to the destination actor.
    It will request at most maxInputBufferSize number of elements from upstream, but there is no back-pressure signal from the destination actor, i.e. if the actor is not consuming the messages fast enough the mailbox of the actor will grow. For potentially slow consumer actors it is recommended to use a bounded mailbox with zero mailbox-push-timeout-time or use a rate limiting stage in front of this Sink.
    
    Parameters:
    
    ref - (undocumented)
    
    onCompleteMessage - (undocumented)
    
    Returns:
    
    (undocumented)
  - actorRefWithAck
```
public static <T> Sink<T,NotUsed> actorRefWithAck(ActorRef ref,
                                                  java.lang.Object onInitMessage,
                                                  java.lang.Object ackMessage,
                                                  java.lang.Object onCompleteMessage,
                                                  scala.Function1<java.lang.Throwable,java.lang.Object> onFailureMessage)
```
    Sends the elements of the stream to the given ActorRef that sends back back-pressure signal. First element is always onInitMessage, then stream is waiting for acknowledgement message ackMessage from the given actor which means that it is ready to process elements. It also requires ackMessage message after each stream element to make backpressure work.
    If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure - result of onFailureMessage(throwable) function will be sent to the destination actor.
    
    Parameters:
    
    ref - (undocumented)
    
    onInitMessage - (undocumented)
    
    ackMessage - (undocumented)
    
    onCompleteMessage - (undocumented)
    
    onFailureMessage - (undocumented)
    
    Returns:
    
    (undocumented)
  - actorSubscriber
```
public static <T> Sink<T,ActorRef> actorSubscriber(Props props)
```
    Creates a Sink that is materialized to an ActorRef which points to an Actor created according to the passed in Props. Actor created by the props must be ActorSubscriber.
    
    Parameters:
    
    props - (undocumented)
    
    Returns:
    
    (undocumented)
  - queue
```
public static <T> Sink<T,SinkQueueWithCancel<T>> queue()
```
    Creates a Sink that is materialized as an SinkQueue. akka.stream.scaladsl.SinkQueue.pull method is pulling element from the stream and returns Future[Option[T}. Future completes when element is available.
    Before calling pull method second time you need to wait until previous Future completes. Pull returns Failed future with ''IllegalStateException'' if previous future has not yet completed.
    Sink will request at most number of elements equal to size of inputBuffer from upstream and then stop back pressure. You can configure size of input buffer by using Sink.withAttributes method.
    For stream completion you need to pull all elements from SinkQueue including last None as completion marker
    See also SinkQueueWithCancel
    
    Returns:
    
    (undocumented)
  - lazyInit
```
public static <T,M> Sink<T,scala.concurrent.Future<M>> lazyInit(scala.Function1<T,scala.concurrent.Future<Sink<T,M>>> sinkFactory,
                                                                scala.Function0<M> fallback)
```
    Creates a real Sink upon receiving the first element. Internal Sink will not be created if there are no elements, because of completion or error.
    If sinkFactory throws an exception and the supervision decision is akka.stream.Supervision.Stop the Future will be completed with failure. For all other supervision options it will try to create sink with next element
    fallback will be executed when there was no elements and completed is received from upstream.
    
    Parameters:
    
    sinkFactory - (undocumented)
    
    fallback - (undocumented)
    
    Returns:
    
    (undocumented)
  - module
```
public StreamLayout.Module module()
```
    Description copied from interface: Graph
    
    INTERNAL API.
    Every materializable element must be backed by a stream layout module
    
    Specified by:
    
    module in interface Graph<SinkShape<In>,Mat>
    
    Returns:
    
    (undocumented)
  - shape
```
public SinkShape<In> shape()
```
    Description copied from interface: Graph
    
    The shape of a graph is all that is externally visible: its inlets and outlets.
    
    Specified by:
    
    shape in interface Graph<SinkShape<In>,Mat>
    
    Returns:
    
    (undocumented)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - contramap
```
public <In2> Sink<In2,Mat> contramap(scala.Function1<In2,In> f)
```
    Transform this Sink by applying a function to each *incoming* upstream element before it is passed to the Sink
    '''Backpressures when''' original Sink backpressures
    '''Cancels when''' original Sink backpressures
    
    Parameters:
    
    f - (undocumented)
    
    Returns:
    
    (undocumented)
  - runWith
```
public <Mat2> Mat2 runWith(Graph<SourceShape<In>,Mat2> source,
                           Materializer materializer)
```
    Connect this Sink to a Source and run it. The returned value is the materialized value of the Source, e.g. the Subscriber of a Source#subscriber.
    
    Parameters:
    
    source - (undocumented)
    
    materializer - (undocumented)
    
    Returns:
    
    (undocumented)
  - mapMaterializedValue
```
public <Mat2> Sink<In,Mat2> mapMaterializedValue(scala.Function1<Mat,Mat2> f)
```
    Transform only the materialized value of this Sink, leaving all other properties as they were.
    
    Parameters:
    
    f - (undocumented)
    
    Returns:
    
    (undocumented)
  - withAttributes
```
public Sink<In,Mat> withAttributes(Attributes attr)
```
    Change the attributes of this Sink to the given ones and seal the list of attributes. This means that further calls will not be able to remove these attributes, but instead add new ones. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing stages).
    
    Specified by:
    
    withAttributes in interface Graph<SinkShape<In>,Mat>
    
    Parameters:
    
    attr - (undocumented)
    
    Returns:
    
    (undocumented)
  - addAttributes
```
public Sink<In,Mat> addAttributes(Attributes attr)
```
    Add the given attributes to this Sink. Further calls to withAttributes will not remove these attributes. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing stages).
    
    Specified by:
    
    addAttributes in interface Graph<SinkShape<In>,Mat>
    
    Parameters:
    
    attr - (undocumented)
    
    Returns:
    
    (undocumented)
  - named
```
public Sink<In,Mat> named(java.lang.String name)
```
    Add a name attribute to this Sink.
    
    Specified by:
    
    named in interface Graph<SinkShape<In>,Mat>
    
    Parameters:
    
    name - (undocumented)
    
    Returns:
    
    (undocumented)
  - async
```
public Sink<In,Mat> async()
```
    Put an asynchronous boundary around this Sink
    
    Specified by:
    
    async in interface Graph<SinkShape<In>,Mat>
    
    Returns:
    
    (undocumented)
  - asJava
```
public Sink<In,Mat> asJava()
```
    Converts this Scala DSL element to it's Java DSL counterpart.
    
    Returns:
    
    (undocumented)

Class Sink<In,Mat>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Sink

Method Detail

fromGraph

fromSubscriber

cancelled

head

headOption

last

lastOption

seq

asPublisher

ignore

foreach

combine

foreachParallel

fold

foldAsync

reduce

onComplete

actorRef

actorRefWithAck

actorSubscriber

queue

lazyInit

module

shape

toString

contramap

runWith

mapMaterializedValue

withAttributes

addAttributes

named

async

asJava