Skip to main content
Ctrl+K
PyFlink 1.20+vvr.11.7.dev0 documentation - Home PyFlink 1.20+vvr.11.7.dev0 documentation - Home
  • API Reference
  • Examples
  • API Reference
  • Examples

Section Navigation

  • PyFlink Table
  • PyFlink DataStream
    • StreamExecutionEnvironment
    • DataStream
    • Functions
    • State
    • Timer
    • Window
    • Checkpoint
    • Side Outputs
    • Asynchronous I/O
    • Connectors
    • Formats
  • PyFlink DataFrame
  • PyFlink Common
  • API Reference
  • PyFlink DataStream
  • DataStream
  • pyflink.datastream.data_stream.DataStreamSink.set_description

pyflink.datastream.data_stream.DataStreamSink.set_description#

DataStreamSink.set_description(description: str) → DataStreamSink[source]#

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.

Added in version 1.15.0.

previous

pyflink.datastream.data_stream.DataStreamSink.set_parallelism

next

pyflink.datastream.data_stream.DataStreamSink.disable_chaining

On this page
  • DataStreamSink.set_description()

This Page

  • Show Source

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.16.1.