DisplayData

import type { DisplayData } from "https://googleapis.deno.dev/v1/dataflow:v1b3.ts";

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

interface DisplayData {

boolValue?: boolean;

durationValue?: number;

floatValue?: number;

int64Value?: bigint;

javaClassValue?: string;

key?: string;

label?: string;

namespace?: string;

shortStrValue?: string;

strValue?: string;

timestampValue?: Date;

url?: string;

}

§Properties

boolValue?: boolean

[src]

Contains value if the data is of a boolean type.

durationValue?: number

[src]

Contains value if the data is of duration type.

floatValue?: number

[src]

Contains value if the data is of float type.

int64Value?: bigint

[src]

Contains value if the data is of int64 type.

javaClassValue?: string

[src]

Contains value if the data is of java class type.

key?: string

[src]

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.

label?: string

[src]

An optional label to display in a dax UI for the element.

namespace?: string

[src]

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.

shortStrValue?: string

[src]

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.

strValue?: string

[src]

Contains value if the data is of string type.

timestampValue?: Date

[src]

Contains value if the data is of timestamp type.

url?: string

[src]

An optional full URL.