HuangXingBo commented on a change in pull request #18380:
URL: https://github.com/apache/flink/pull/18380#discussion_r786496796
##########
File path: flink-python/pyflink/datastream/data_stream.py
##########
@@ -231,6 +231,24 @@ def slot_sharing_group(self, slot_sharing_group:
Union[str, SlotSharingGroup]) -
self._j_data_stream.slotSharingGroup(slot_sharing_group)
return self
+ def set_description(self, description: str):
Review comment:
```suggestion
def set_description(self, description: str) -> 'DataStream':
```
##########
File path: flink-python/pyflink/datastream/data_stream.py
##########
@@ -231,6 +231,24 @@ def slot_sharing_group(self, slot_sharing_group:
Union[str, SlotSharingGroup]) -
self._j_data_stream.slotSharingGroup(slot_sharing_group)
return self
+ def set_description(self, description: str):
+ """
+ Sets the description for this operator.
+
+ 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
+ operator, 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.
+
+ :param description: The description for this operator.
+ :return: The sink with new description.
Review comment:
```suggestion
:return: The operation with new description.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
