pyflink.datastream.data_stream.DataStreamSink.set_description

DataStreamSink.set_description(description: str) → pyflink.datastream.data_stream.DataStreamSink

Sets the description for this sink.

Description is used in json plan and web ui, but not in logging and metrics where only name is available. Description is expected to provide detailed information about the sink, while name is expected to be more simple, providing summary information only, so that we can have more user-friendly logging messages and metric tags without losing useful messages for debugging.

Parameters

description – The description for this sink.

Returns

The sink with new description.

New in version 1.15.0.