Google Cloud Dataflow V1beta3 Client - Class DisplayData (0.5.1)

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 message google.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.
`↳ str_value`	`string` Contains value if the data is of string type.
`↳ int64_value`	`int\|string` Contains value if the data is of int64 type.
`↳ float_value`	`float` Contains value if the data is of float type.
`↳ java_class_value`	`string` Contains value if the data is of java class type.
`↳ timestamp_value`	`Google\Protobuf\Timestamp` Contains value if the data is of timestamp type.
`↳ duration_value`	`Google\Protobuf\Duration` Contains value if the data is of duration type.
`↳ bool_value`	`bool` Contains value if the data is of a boolean type.
`↳ short_str_value`	`string` 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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStrValue

Contains value if the data is of string type.

Returns
Type	Description
`string`

hasStrValue

setStrValue

Contains value if the data is of string type.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInt64Value

Contains value if the data is of int64 type.

Returns
Type	Description
`int\|string`

hasInt64Value

setInt64Value

Contains value if the data is of int64 type.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getFloatValue

Contains value if the data is of float type.

Returns
Type	Description
`float`

hasFloatValue

setFloatValue

Contains value if the data is of float type.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getJavaClassValue

Contains value if the data is of java class type.

Returns
Type	Description
`string`

hasJavaClassValue

setJavaClassValue

Contains value if the data is of java class type.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTimestampValue

Contains value if the data is of timestamp type.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasTimestampValue

setTimestampValue

Contains value if the data is of timestamp type.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDurationValue

Contains value if the data is of duration type.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasDurationValue

setDurationValue

Contains value if the data is of duration type.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getBoolValue

Contains value if the data is of a boolean type.

Returns
Type	Description
`bool`

hasBoolValue

setBoolValue

Contains value if the data is of a boolean type.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getShortStrValue

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.

Returns
Type	Description
`string`

setShortStrValue

A possible additional shorter value to display.

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValue

Returns
Type	Description
`string`