Class Widget.Builder (2.5.2)

Stay organized with collections Save and categorize content based on your preferences.
public static final class Widget.Builder extends GeneratedMessageV3.Builder<Widget.Builder> implements WidgetOrBuilder

Widget contains a single dashboard component and configuration of how to present the component in the dashboard.

Protobuf type google.monitoring.dashboard.v1.Widget

Implements

WidgetOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Widget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Widget.Builder
Overrides

build()

public Widget build()
Returns
TypeDescription
Widget

buildPartial()

public Widget buildPartial()
Returns
TypeDescription
Widget

clear()

public Widget.Builder clear()
Returns
TypeDescription
Widget.Builder
Overrides

clearAlertChart()

public Widget.Builder clearAlertChart()

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Returns
TypeDescription
Widget.Builder

clearBlank()

public Widget.Builder clearBlank()

A blank space.

.google.protobuf.Empty blank = 5;

Returns
TypeDescription
Widget.Builder

clearCollapsibleGroup()

public Widget.Builder clearCollapsibleGroup()

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Returns
TypeDescription
Widget.Builder

clearContent()

public Widget.Builder clearContent()
Returns
TypeDescription
Widget.Builder

clearField(Descriptors.FieldDescriptor field)

public Widget.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Widget.Builder
Overrides

clearLogsPanel()

public Widget.Builder clearLogsPanel()

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Returns
TypeDescription
Widget.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Widget.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Widget.Builder
Overrides

clearScorecard()

public Widget.Builder clearScorecard()

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Returns
TypeDescription
Widget.Builder

clearText()

public Widget.Builder clearText()

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Returns
TypeDescription
Widget.Builder

clearTimeSeriesTable()

public Widget.Builder clearTimeSeriesTable()

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Returns
TypeDescription
Widget.Builder

clearTitle()

public Widget.Builder clearTitle()

Optional. The title of the widget.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Widget.Builder

This builder for chaining.

clearXyChart()

public Widget.Builder clearXyChart()

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Returns
TypeDescription
Widget.Builder

clone()

public Widget.Builder clone()
Returns
TypeDescription
Widget.Builder
Overrides

getAlertChart()

public AlertChart getAlertChart()

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Returns
TypeDescription
AlertChart

The alertChart.

getAlertChartBuilder()

public AlertChart.Builder getAlertChartBuilder()

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Returns
TypeDescription
AlertChart.Builder

getAlertChartOrBuilder()

public AlertChartOrBuilder getAlertChartOrBuilder()

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Returns
TypeDescription
AlertChartOrBuilder

getBlank()

public Empty getBlank()

A blank space.

.google.protobuf.Empty blank = 5;

Returns
TypeDescription
Empty

The blank.

getBlankBuilder()

public Empty.Builder getBlankBuilder()

A blank space.

.google.protobuf.Empty blank = 5;

Returns
TypeDescription
Builder

getBlankOrBuilder()

public EmptyOrBuilder getBlankOrBuilder()

A blank space.

.google.protobuf.Empty blank = 5;

Returns
TypeDescription
EmptyOrBuilder

getCollapsibleGroup()

public CollapsibleGroup getCollapsibleGroup()

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Returns
TypeDescription
CollapsibleGroup

The collapsibleGroup.

getCollapsibleGroupBuilder()

public CollapsibleGroup.Builder getCollapsibleGroupBuilder()

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Returns
TypeDescription
CollapsibleGroup.Builder

getCollapsibleGroupOrBuilder()

public CollapsibleGroupOrBuilder getCollapsibleGroupOrBuilder()

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Returns
TypeDescription
CollapsibleGroupOrBuilder

getContentCase()

public Widget.ContentCase getContentCase()
Returns
TypeDescription
Widget.ContentCase

getDefaultInstanceForType()

public Widget getDefaultInstanceForType()
Returns
TypeDescription
Widget

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLogsPanel()

public LogsPanel getLogsPanel()

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Returns
TypeDescription
LogsPanel

The logsPanel.

getLogsPanelBuilder()

public LogsPanel.Builder getLogsPanelBuilder()

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Returns
TypeDescription
LogsPanel.Builder

getLogsPanelOrBuilder()

public LogsPanelOrBuilder getLogsPanelOrBuilder()

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Returns
TypeDescription
LogsPanelOrBuilder

getScorecard()

public Scorecard getScorecard()

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Returns
TypeDescription
Scorecard

The scorecard.

getScorecardBuilder()

public Scorecard.Builder getScorecardBuilder()

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Returns
TypeDescription
Scorecard.Builder

getScorecardOrBuilder()

public ScorecardOrBuilder getScorecardOrBuilder()

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Returns
TypeDescription
ScorecardOrBuilder

getText()

public Text getText()

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Returns
TypeDescription
Text

The text.

getTextBuilder()

public Text.Builder getTextBuilder()

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Returns
TypeDescription
Text.Builder

getTextOrBuilder()

public TextOrBuilder getTextOrBuilder()

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Returns
TypeDescription
TextOrBuilder

getTimeSeriesTable()

public TimeSeriesTable getTimeSeriesTable()

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Returns
TypeDescription
TimeSeriesTable

The timeSeriesTable.

getTimeSeriesTableBuilder()

public TimeSeriesTable.Builder getTimeSeriesTableBuilder()

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Returns
TypeDescription
TimeSeriesTable.Builder

getTimeSeriesTableOrBuilder()

public TimeSeriesTableOrBuilder getTimeSeriesTableOrBuilder()

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Returns
TypeDescription
TimeSeriesTableOrBuilder

getTitle()

public String getTitle()

Optional. The title of the widget.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Optional. The title of the widget.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for title.

getXyChart()

public XyChart getXyChart()

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Returns
TypeDescription
XyChart

The xyChart.

getXyChartBuilder()

public XyChart.Builder getXyChartBuilder()

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Returns
TypeDescription
XyChart.Builder

getXyChartOrBuilder()

public XyChartOrBuilder getXyChartOrBuilder()

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Returns
TypeDescription
XyChartOrBuilder

hasAlertChart()

public boolean hasAlertChart()

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Returns
TypeDescription
boolean

Whether the alertChart field is set.

hasBlank()

public boolean hasBlank()

A blank space.

.google.protobuf.Empty blank = 5;

Returns
TypeDescription
boolean

Whether the blank field is set.

hasCollapsibleGroup()

public boolean hasCollapsibleGroup()

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Returns
TypeDescription
boolean

Whether the collapsibleGroup field is set.

hasLogsPanel()

public boolean hasLogsPanel()

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Returns
TypeDescription
boolean

Whether the logsPanel field is set.

hasScorecard()

public boolean hasScorecard()

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Returns
TypeDescription
boolean

Whether the scorecard field is set.

hasText()

public boolean hasText()

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Returns
TypeDescription
boolean

Whether the text field is set.

hasTimeSeriesTable()

public boolean hasTimeSeriesTable()

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Returns
TypeDescription
boolean

Whether the timeSeriesTable field is set.

hasXyChart()

public boolean hasXyChart()

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Returns
TypeDescription
boolean

Whether the xyChart field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAlertChart(AlertChart value)

public Widget.Builder mergeAlertChart(AlertChart value)

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Parameter
NameDescription
valueAlertChart
Returns
TypeDescription
Widget.Builder

mergeBlank(Empty value)

public Widget.Builder mergeBlank(Empty value)

A blank space.

.google.protobuf.Empty blank = 5;

Parameter
NameDescription
valueEmpty
Returns
TypeDescription
Widget.Builder

mergeCollapsibleGroup(CollapsibleGroup value)

public Widget.Builder mergeCollapsibleGroup(CollapsibleGroup value)

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Parameter
NameDescription
valueCollapsibleGroup
Returns
TypeDescription
Widget.Builder

mergeFrom(Widget other)

public Widget.Builder mergeFrom(Widget other)
Parameter
NameDescription
otherWidget
Returns
TypeDescription
Widget.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Widget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Widget.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Widget.Builder
Overrides

mergeLogsPanel(LogsPanel value)

public Widget.Builder mergeLogsPanel(LogsPanel value)

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Parameter
NameDescription
valueLogsPanel
Returns
TypeDescription
Widget.Builder

mergeScorecard(Scorecard value)

public Widget.Builder mergeScorecard(Scorecard value)

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Parameter
NameDescription
valueScorecard
Returns
TypeDescription
Widget.Builder

mergeText(Text value)

public Widget.Builder mergeText(Text value)

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Parameter
NameDescription
valueText
Returns
TypeDescription
Widget.Builder

mergeTimeSeriesTable(TimeSeriesTable value)

public Widget.Builder mergeTimeSeriesTable(TimeSeriesTable value)

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Parameter
NameDescription
valueTimeSeriesTable
Returns
TypeDescription
Widget.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Widget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Widget.Builder
Overrides

mergeXyChart(XyChart value)

public Widget.Builder mergeXyChart(XyChart value)

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Parameter
NameDescription
valueXyChart
Returns
TypeDescription
Widget.Builder

setAlertChart(AlertChart value)

public Widget.Builder setAlertChart(AlertChart value)

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Parameter
NameDescription
valueAlertChart
Returns
TypeDescription
Widget.Builder

setAlertChart(AlertChart.Builder builderForValue)

public Widget.Builder setAlertChart(AlertChart.Builder builderForValue)

A chart of alert policy data.

.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;

Parameter
NameDescription
builderForValueAlertChart.Builder
Returns
TypeDescription
Widget.Builder

setBlank(Empty value)

public Widget.Builder setBlank(Empty value)

A blank space.

.google.protobuf.Empty blank = 5;

Parameter
NameDescription
valueEmpty
Returns
TypeDescription
Widget.Builder

setBlank(Empty.Builder builderForValue)

public Widget.Builder setBlank(Empty.Builder builderForValue)

A blank space.

.google.protobuf.Empty blank = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Widget.Builder

setCollapsibleGroup(CollapsibleGroup value)

public Widget.Builder setCollapsibleGroup(CollapsibleGroup value)

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Parameter
NameDescription
valueCollapsibleGroup
Returns
TypeDescription
Widget.Builder

setCollapsibleGroup(CollapsibleGroup.Builder builderForValue)

public Widget.Builder setCollapsibleGroup(CollapsibleGroup.Builder builderForValue)

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

.google.monitoring.dashboard.v1.CollapsibleGroup collapsible_group = 9;

Parameter
NameDescription
builderForValueCollapsibleGroup.Builder
Returns
TypeDescription
Widget.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Widget.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Widget.Builder
Overrides

setLogsPanel(LogsPanel value)

public Widget.Builder setLogsPanel(LogsPanel value)

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Parameter
NameDescription
valueLogsPanel
Returns
TypeDescription
Widget.Builder

setLogsPanel(LogsPanel.Builder builderForValue)

public Widget.Builder setLogsPanel(LogsPanel.Builder builderForValue)

A widget that shows a stream of logs.

.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;

Parameter
NameDescription
builderForValueLogsPanel.Builder
Returns
TypeDescription
Widget.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Widget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Widget.Builder
Overrides

setScorecard(Scorecard value)

public Widget.Builder setScorecard(Scorecard value)

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Parameter
NameDescription
valueScorecard
Returns
TypeDescription
Widget.Builder

setScorecard(Scorecard.Builder builderForValue)

public Widget.Builder setScorecard(Scorecard.Builder builderForValue)

A scorecard summarizing time series data.

.google.monitoring.dashboard.v1.Scorecard scorecard = 3;

Parameter
NameDescription
builderForValueScorecard.Builder
Returns
TypeDescription
Widget.Builder

setText(Text value)

public Widget.Builder setText(Text value)

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Parameter
NameDescription
valueText
Returns
TypeDescription
Widget.Builder

setText(Text.Builder builderForValue)

public Widget.Builder setText(Text.Builder builderForValue)

A raw string or markdown displaying textual content.

.google.monitoring.dashboard.v1.Text text = 4;

Parameter
NameDescription
builderForValueText.Builder
Returns
TypeDescription
Widget.Builder

setTimeSeriesTable(TimeSeriesTable value)

public Widget.Builder setTimeSeriesTable(TimeSeriesTable value)

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Parameter
NameDescription
valueTimeSeriesTable
Returns
TypeDescription
Widget.Builder

setTimeSeriesTable(TimeSeriesTable.Builder builderForValue)

public Widget.Builder setTimeSeriesTable(TimeSeriesTable.Builder builderForValue)

A widget that displays time series data in a tabular format.

.google.monitoring.dashboard.v1.TimeSeriesTable time_series_table = 8;

Parameter
NameDescription
builderForValueTimeSeriesTable.Builder
Returns
TypeDescription
Widget.Builder

setTitle(String value)

public Widget.Builder setTitle(String value)

Optional. The title of the widget.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The title to set.

Returns
TypeDescription
Widget.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public Widget.Builder setTitleBytes(ByteString value)

Optional. The title of the widget.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for title to set.

Returns
TypeDescription
Widget.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Widget.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Widget.Builder
Overrides

setXyChart(XyChart value)

public Widget.Builder setXyChart(XyChart value)

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Parameter
NameDescription
valueXyChart
Returns
TypeDescription
Widget.Builder

setXyChart(XyChart.Builder builderForValue)

public Widget.Builder setXyChart(XyChart.Builder builderForValue)

A chart of time series data.

.google.monitoring.dashboard.v1.XyChart xy_chart = 2;

Parameter
NameDescription
builderForValueXyChart.Builder
Returns
TypeDescription
Widget.Builder