Class DisplayData (0.6.0)

DisplayData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Data provided with a pipeline or transform to provide descriptive info.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
key str
The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.
namespace str
The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.
str_value str
Contains value if the data is of string type. This field is a member of `oneof`_ ``Value``.
int64_value int
Contains value if the data is of int64 type. This field is a member of `oneof`_ ``Value``.
float_value float
Contains value if the data is of float type. This field is a member of `oneof`_ ``Value``.
java_class_value str
Contains value if the data is of java class type. This field is a member of `oneof`_ ``Value``.
timestamp_value google.protobuf.timestamp_pb2.Timestamp
Contains value if the data is of timestamp type. This field is a member of `oneof`_ ``Value``.
duration_value google.protobuf.duration_pb2.Duration
Contains value if the data is of duration type. This field is a member of `oneof`_ ``Value``.
bool_value bool
Contains value if the data is of a boolean type. This field is a member of `oneof`_ ``Value``.
short_str_value str
A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.
url str
An optional full URL.
label str
An optional label to display in a dax UI for the element.

Inheritance

builtins.object > proto.message.Message > DisplayData