Class DashboardChart.Visualization (0.31.0)

public static final class DashboardChart.Visualization extends GeneratedMessage implements DashboardChart.VisualizationOrBuilder

Visualization config for a chart. https://echarts.apache.org/en/option.html#series

Protobuf type google.cloud.chronicle.v1.DashboardChart.Visualization

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DashboardChart.Visualization

Static Fields

BUTTON_FIELD_NUMBER

public static final int BUTTON_FIELD_NUMBER
Field Value
Type Description
int

COLUMN_DEFS_FIELD_NUMBER

public static final int COLUMN_DEFS_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_MAPS_CONFIG_FIELD_NUMBER

public static final int GOOGLE_MAPS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

GROUPING_TYPE_FIELD_NUMBER

public static final int GROUPING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LEGENDS_FIELD_NUMBER

public static final int LEGENDS_FIELD_NUMBER
Field Value
Type Description
int

MARKDOWN_FIELD_NUMBER

public static final int MARKDOWN_FIELD_NUMBER
Field Value
Type Description
int

SERIES_COLUMN_FIELD_NUMBER

public static final int SERIES_COLUMN_FIELD_NUMBER
Field Value
Type Description
int

SERIES_FIELD_NUMBER

public static final int SERIES_FIELD_NUMBER
Field Value
Type Description
int

TABLE_CONFIG_FIELD_NUMBER

public static final int TABLE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

THRESHOLD_COLORING_ENABLED_FIELD_NUMBER

public static final int THRESHOLD_COLORING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

TOOLTIP_FIELD_NUMBER

public static final int TOOLTIP_FIELD_NUMBER
Field Value
Type Description
int

VISUAL_MAPS_FIELD_NUMBER

public static final int VISUAL_MAPS_FIELD_NUMBER
Field Value
Type Description
int

X_AXES_FIELD_NUMBER

public static final int X_AXES_FIELD_NUMBER
Field Value
Type Description
int

Y_AXES_FIELD_NUMBER

public static final int Y_AXES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DashboardChart.Visualization getDefaultInstance()
Returns
Type Description
DashboardChart.Visualization

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DashboardChart.Visualization.Builder newBuilder()
Returns
Type Description
DashboardChart.Visualization.Builder

newBuilder(DashboardChart.Visualization prototype)

public static DashboardChart.Visualization.Builder newBuilder(DashboardChart.Visualization prototype)
Parameter
Name Description
prototype DashboardChart.Visualization
Returns
Type Description
DashboardChart.Visualization.Builder

parseDelimitedFrom(InputStream input)

public static DashboardChart.Visualization parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardChart.Visualization parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DashboardChart.Visualization parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DashboardChart.Visualization parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DashboardChart.Visualization parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DashboardChart.Visualization parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DashboardChart.Visualization parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardChart.Visualization parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DashboardChart.Visualization parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardChart.Visualization parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DashboardChart.Visualization parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DashboardChart.Visualization parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DashboardChart.Visualization> parser()
Returns
Type Description
Parser<Visualization>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getButton()

public Button getButton()

Button config for a chart if tileType is TILE_TYPE_BUTTON.

.google.cloud.chronicle.v1.Button button = 11;

Returns
Type Description
Button

The button.

getButtonOrBuilder()

public ButtonOrBuilder getButtonOrBuilder()

Button config for a chart if tileType is TILE_TYPE_BUTTON.

.google.cloud.chronicle.v1.Button button = 11;

Returns
Type Description
ButtonOrBuilder

getColumnDefs(int index)

public DashboardChart.Visualization.ColumnDef getColumnDefs(int index)

Column Definition to represent chart as a table.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.ColumnDef column_defs = 10;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.ColumnDef

getColumnDefsCount()

public int getColumnDefsCount()

Column Definition to represent chart as a table.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.ColumnDef column_defs = 10;

Returns
Type Description
int

getColumnDefsList()

public List<DashboardChart.Visualization.ColumnDef> getColumnDefsList()

Column Definition to represent chart as a table.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.ColumnDef column_defs = 10;

Returns
Type Description
List<ColumnDef>

getColumnDefsOrBuilder(int index)

public DashboardChart.Visualization.ColumnDefOrBuilder getColumnDefsOrBuilder(int index)

Column Definition to represent chart as a table.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.ColumnDef column_defs = 10;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.ColumnDefOrBuilder

getColumnDefsOrBuilderList()

public List<? extends DashboardChart.Visualization.ColumnDefOrBuilder> getColumnDefsOrBuilderList()

Column Definition to represent chart as a table.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.ColumnDef column_defs = 10;

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.DashboardChart.Visualization.ColumnDefOrBuilder>

getDefaultInstanceForType()

public DashboardChart.Visualization getDefaultInstanceForType()
Returns
Type Description
DashboardChart.Visualization

getGoogleMapsConfig()

public DashboardChart.Visualization.GoogleMapsConfig getGoogleMapsConfig()

Optional. Google Maps config for a chart if type is GOOGLE MAPS.

.google.cloud.chronicle.v1.DashboardChart.Visualization.GoogleMapsConfig google_maps_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.Visualization.GoogleMapsConfig

The googleMapsConfig.

getGoogleMapsConfigOrBuilder()

public DashboardChart.Visualization.GoogleMapsConfigOrBuilder getGoogleMapsConfigOrBuilder()

Optional. Google Maps config for a chart if type is GOOGLE MAPS.

.google.cloud.chronicle.v1.DashboardChart.Visualization.GoogleMapsConfig google_maps_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.Visualization.GoogleMapsConfigOrBuilder

getGroupingType()

public String getGroupingType()

Optional. Selected grouping type for series

string grouping_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The groupingType.

getGroupingTypeBytes()

public ByteString getGroupingTypeBytes()

Optional. Selected grouping type for series

string grouping_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for groupingType.

getLegends(int index)

public DashboardChart.Visualization.Legend getLegends(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.Legend

getLegendsCount()

public int getLegendsCount()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;

Returns
Type Description
int

getLegendsList()

public List<DashboardChart.Visualization.Legend> getLegendsList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;

Returns
Type Description
List<Legend>

getLegendsOrBuilder(int index)

public DashboardChart.Visualization.LegendOrBuilder getLegendsOrBuilder(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.LegendOrBuilder

getLegendsOrBuilderList()

public List<? extends DashboardChart.Visualization.LegendOrBuilder> getLegendsOrBuilderList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.DashboardChart.Visualization.LegendOrBuilder>

getMarkdown()

public Markdown getMarkdown()

Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN.

.google.cloud.chronicle.v1.Markdown markdown = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Markdown

The markdown.

getMarkdownOrBuilder()

public MarkdownOrBuilder getMarkdownOrBuilder()

Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN.

.google.cloud.chronicle.v1.Markdown markdown = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MarkdownOrBuilder

getParserForType()

public Parser<DashboardChart.Visualization> getParserForType()
Returns
Type Description
Parser<Visualization>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSeries(int index)

public DashboardChart.Visualization.Series getSeries(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.Series

getSeriesColumn(int index)

public String getSeriesColumn(int index)

Optional. Selected column for series

repeated string series_column = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The seriesColumn at the given index.

getSeriesColumnBytes(int index)

public ByteString getSeriesColumnBytes(int index)

Optional. Selected column for series

repeated string series_column = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the seriesColumn at the given index.

getSeriesColumnCount()

public int getSeriesColumnCount()

Optional. Selected column for series

repeated string series_column = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of seriesColumn.

getSeriesColumnList()

public ProtocolStringList getSeriesColumnList()

Optional. Selected column for series

repeated string series_column = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the seriesColumn.

getSeriesCount()

public int getSeriesCount()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;

Returns
Type Description
int

getSeriesList()

public List<DashboardChart.Visualization.Series> getSeriesList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;

Returns
Type Description
List<Series>

getSeriesOrBuilder(int index)

public DashboardChart.Visualization.SeriesOrBuilder getSeriesOrBuilder(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.SeriesOrBuilder

getSeriesOrBuilderList()

public List<? extends DashboardChart.Visualization.SeriesOrBuilder> getSeriesOrBuilderList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.DashboardChart.Visualization.SeriesOrBuilder>

getTableConfig()

public DashboardChart.Visualization.TableConfig getTableConfig()

Optional. Configuration for table appearance.

.google.cloud.chronicle.v1.DashboardChart.Visualization.TableConfig table_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.Visualization.TableConfig

The tableConfig.

getTableConfigOrBuilder()

public DashboardChart.Visualization.TableConfigOrBuilder getTableConfigOrBuilder()

Optional. Configuration for table appearance.

.google.cloud.chronicle.v1.DashboardChart.Visualization.TableConfig table_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.Visualization.TableConfigOrBuilder

getThresholdColoringEnabled()

public boolean getThresholdColoringEnabled()

Optional. Whether threshold coloring is enabled for the chart. If it's enabled, the chart will be colored based on the values stored in VisualMap below.

bool threshold_coloring_enabled = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The thresholdColoringEnabled.

getTooltip()

public DashboardChart.Visualization.Tooltip getTooltip()

.google.cloud.chronicle.v1.DashboardChart.Visualization.Tooltip tooltip = 4;

Returns
Type Description
DashboardChart.Visualization.Tooltip

The tooltip.

getTooltipOrBuilder()

public DashboardChart.Visualization.TooltipOrBuilder getTooltipOrBuilder()

.google.cloud.chronicle.v1.DashboardChart.Visualization.Tooltip tooltip = 4;

Returns
Type Description
DashboardChart.Visualization.TooltipOrBuilder

getVisualMaps(int index)

public DashboardChart.Visualization.VisualMap getVisualMaps(int index)

Optional. Visual maps for the chart.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.VisualMap visual_maps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.VisualMap

getVisualMapsCount()

public int getVisualMapsCount()

Optional. Visual maps for the chart.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.VisualMap visual_maps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVisualMapsList()

public List<DashboardChart.Visualization.VisualMap> getVisualMapsList()

Optional. Visual maps for the chart.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.VisualMap visual_maps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VisualMap>

getVisualMapsOrBuilder(int index)

public DashboardChart.Visualization.VisualMapOrBuilder getVisualMapsOrBuilder(int index)

Optional. Visual maps for the chart.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.VisualMap visual_maps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.VisualMapOrBuilder

getVisualMapsOrBuilderList()

public List<? extends DashboardChart.Visualization.VisualMapOrBuilder> getVisualMapsOrBuilderList()

Optional. Visual maps for the chart.

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.VisualMap visual_maps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.DashboardChart.Visualization.VisualMapOrBuilder>

getXAxes(int index)

public DashboardChart.Visualization.Axis getXAxes(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.Axis

getXAxesCount()

public int getXAxesCount()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;

Returns
Type Description
int

getXAxesList()

public List<DashboardChart.Visualization.Axis> getXAxesList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;

Returns
Type Description
List<Axis>

getXAxesOrBuilder(int index)

public DashboardChart.Visualization.AxisOrBuilder getXAxesOrBuilder(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.AxisOrBuilder

getXAxesOrBuilderList()

public List<? extends DashboardChart.Visualization.AxisOrBuilder> getXAxesOrBuilderList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.DashboardChart.Visualization.AxisOrBuilder>

getYAxes(int index)

public DashboardChart.Visualization.Axis getYAxes(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.Axis

getYAxesCount()

public int getYAxesCount()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;

Returns
Type Description
int

getYAxesList()

public List<DashboardChart.Visualization.Axis> getYAxesList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;

Returns
Type Description
List<Axis>

getYAxesOrBuilder(int index)

public DashboardChart.Visualization.AxisOrBuilder getYAxesOrBuilder(int index)

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;

Parameter
Name Description
index int
Returns
Type Description
DashboardChart.Visualization.AxisOrBuilder

getYAxesOrBuilderList()

public List<? extends DashboardChart.Visualization.AxisOrBuilder> getYAxesOrBuilderList()

repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.DashboardChart.Visualization.AxisOrBuilder>

hasButton()

public boolean hasButton()

Button config for a chart if tileType is TILE_TYPE_BUTTON.

.google.cloud.chronicle.v1.Button button = 11;

Returns
Type Description
boolean

Whether the button field is set.

hasGoogleMapsConfig()

public boolean hasGoogleMapsConfig()

Optional. Google Maps config for a chart if type is GOOGLE MAPS.

.google.cloud.chronicle.v1.DashboardChart.Visualization.GoogleMapsConfig google_maps_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the googleMapsConfig field is set.

hasMarkdown()

public boolean hasMarkdown()

Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN.

.google.cloud.chronicle.v1.Markdown markdown = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the markdown field is set.

hasTableConfig()

public boolean hasTableConfig()

Optional. Configuration for table appearance.

.google.cloud.chronicle.v1.DashboardChart.Visualization.TableConfig table_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the tableConfig field is set.

hasTooltip()

public boolean hasTooltip()

.google.cloud.chronicle.v1.DashboardChart.Visualization.Tooltip tooltip = 4;

Returns
Type Description
boolean

Whether the tooltip field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DashboardChart.Visualization.Builder newBuilderForType()
Returns
Type Description
DashboardChart.Visualization.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DashboardChart.Visualization.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DashboardChart.Visualization.Builder
Overrides

toBuilder()

public DashboardChart.Visualization.Builder toBuilder()
Returns
Type Description
DashboardChart.Visualization.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException