Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class DisplayData.
Data provided with a pipeline or transform to provide descriptive info.
Generated from protobuf messagegoogle.dataflow.v1beta3.DisplayData
Namespace
Google \ Cloud \ Dataflow \ V1beta3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ key
string
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
string
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.
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
string
An optional full URL.
↳ label
string
An optional label to display in a dax UI for the element.
getKey
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.
Returns
Type
Description
string
setKey
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getNamespace
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.
Returns
Type
Description
string
setNamespace
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.
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.
Returns
Type
Description
string
setShortStrValue
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUrl
An optional full URL.
Returns
Type
Description
string
setUrl
An optional full URL.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLabel
An optional label to display in a dax UI for the element.
Returns
Type
Description
string
setLabel
An optional label to display in a dax UI for the element.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataflow V1beta3 Client - Class DisplayData (0.8.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.2 (latest)](/php/docs/reference/cloud-dataflow/latest/V1beta3.DisplayData)\n- [0.8.1](/php/docs/reference/cloud-dataflow/0.8.1/V1beta3.DisplayData)\n- [0.7.1](/php/docs/reference/cloud-dataflow/0.7.1/V1beta3.DisplayData)\n- [0.6.6](/php/docs/reference/cloud-dataflow/0.6.6/V1beta3.DisplayData)\n- [0.5.1](/php/docs/reference/cloud-dataflow/0.5.1/V1beta3.DisplayData)\n- [0.4.1](/php/docs/reference/cloud-dataflow/0.4.1/V1beta3.DisplayData)\n- [0.3.10](/php/docs/reference/cloud-dataflow/0.3.10/V1beta3.DisplayData) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class DisplayData.\n\nData provided with a pipeline or transform to provide descriptive info.\n\nGenerated from protobuf message `google.dataflow.v1beta3.DisplayData`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataflow \\\\ V1beta3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getKey\n\nThe key identifying the display data.\n\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.\n\n### setKey\n\nThe key identifying the display data.\n\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.\n\n### getNamespace\n\nThe namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\n\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.\n\n### setNamespace\n\nThe namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\n\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.\n\n### getStrValue\n\nContains value if the data is of string type.\n\n### hasStrValue\n\n### setStrValue\n\nContains value if the data is of string type.\n\n### getInt64Value\n\nContains value if the data is of int64 type.\n\n### hasInt64Value\n\n### setInt64Value\n\nContains value if the data is of int64 type.\n\n### getFloatValue\n\nContains value if the data is of float type.\n\n### hasFloatValue\n\n### setFloatValue\n\nContains value if the data is of float type.\n\n### getJavaClassValue\n\nContains value if the data is of java class type.\n\n### hasJavaClassValue\n\n### setJavaClassValue\n\nContains value if the data is of java class type.\n\n### getTimestampValue\n\nContains value if the data is of timestamp type.\n\n### hasTimestampValue\n\n### setTimestampValue\n\nContains value if the data is of timestamp type.\n\n### getDurationValue\n\nContains value if the data is of duration type.\n\n### hasDurationValue\n\n### setDurationValue\n\nContains value if the data is of duration type.\n\n### getBoolValue\n\nContains value if the data is of a boolean type.\n\n### hasBoolValue\n\n### setBoolValue\n\nContains value if the data is of a boolean type.\n\n### getShortStrValue\n\nA possible additional shorter value to display.\n\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.\n\n### setShortStrValue\n\nA possible additional shorter value to display.\n\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.\n\n### getUrl\n\nAn optional full URL.\n\n### setUrl\n\nAn optional full URL.\n\n### getLabel\n\nAn optional label to display in a dax UI for the element.\n\n### setLabel\n\nAn optional label to display in a dax UI for the element.\n\n### getValue"]]
