Class Widget (2.37.0)

public final class Widget extends GeneratedMessageV3 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 Fields

ALERT_CHART_FIELD_NUMBER

public static final int ALERT_CHART_FIELD_NUMBER
Field Value
TypeDescription
int

BLANK_FIELD_NUMBER

public static final int BLANK_FIELD_NUMBER
Field Value
TypeDescription
int

COLLAPSIBLE_GROUP_FIELD_NUMBER

public static final int COLLAPSIBLE_GROUP_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_REPORTING_PANEL_FIELD_NUMBER

public static final int ERROR_REPORTING_PANEL_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INCIDENT_LIST_FIELD_NUMBER

public static final int INCIDENT_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

LOGS_PANEL_FIELD_NUMBER

public static final int LOGS_PANEL_FIELD_NUMBER
Field Value
TypeDescription
int

PIE_CHART_FIELD_NUMBER

public static final int PIE_CHART_FIELD_NUMBER
Field Value
TypeDescription
int

SCORECARD_FIELD_NUMBER

public static final int SCORECARD_FIELD_NUMBER
Field Value
TypeDescription
int

SECTION_HEADER_FIELD_NUMBER

public static final int SECTION_HEADER_FIELD_NUMBER
Field Value
TypeDescription
int

SINGLE_VIEW_GROUP_FIELD_NUMBER

public static final int SINGLE_VIEW_GROUP_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_SERIES_TABLE_FIELD_NUMBER

public static final int TIME_SERIES_TABLE_FIELD_NUMBER
Field Value
TypeDescription
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
TypeDescription
int

XY_CHART_FIELD_NUMBER

public static final int XY_CHART_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Widget getDefaultInstance()
Returns
TypeDescription
Widget

getDescriptor()

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

newBuilder()

public static Widget.Builder newBuilder()
Returns
TypeDescription
Widget.Builder

newBuilder(Widget prototype)

public static Widget.Builder newBuilder(Widget prototype)
Parameter
NameDescription
prototypeWidget
Returns
TypeDescription
Widget.Builder

parseDelimitedFrom(InputStream input)

public static Widget parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Widget
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Widget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Widget parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Widget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Widget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Widget parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Widget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Widget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Widget parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Widget
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Widget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Widget parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Widget
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Widget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Widget parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Widget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Widget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Widget
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Widget> parser()
Returns
TypeDescription
Parser<Widget>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAlertChart()

public AlertChart getAlertChart()

A chart of alert policy data.

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

Returns
TypeDescription
AlertChart

The alertChart.

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.

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.

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

getErrorReportingPanel()

public ErrorReportingPanel getErrorReportingPanel()

A widget that displays a list of error groups.

.google.monitoring.dashboard.v1.ErrorReportingPanel error_reporting_panel = 19;

Returns
TypeDescription
ErrorReportingPanel

The errorReportingPanel.

getErrorReportingPanelOrBuilder()

public ErrorReportingPanelOrBuilder getErrorReportingPanelOrBuilder()

A widget that displays a list of error groups.

.google.monitoring.dashboard.v1.ErrorReportingPanel error_reporting_panel = 19;

Returns
TypeDescription
ErrorReportingPanelOrBuilder

getId()

public String getId()

Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.

string id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.

string id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for id.

getIncidentList()

public IncidentList getIncidentList()

A widget that shows list of incidents.

.google.monitoring.dashboard.v1.IncidentList incident_list = 12;

Returns
TypeDescription
IncidentList

The incidentList.

getIncidentListOrBuilder()

public IncidentListOrBuilder getIncidentListOrBuilder()

A widget that shows list of incidents.

.google.monitoring.dashboard.v1.IncidentList incident_list = 12;

Returns
TypeDescription
IncidentListOrBuilder

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.

getLogsPanelOrBuilder()

public LogsPanelOrBuilder getLogsPanelOrBuilder()

A widget that shows a stream of logs.

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

Returns
TypeDescription
LogsPanelOrBuilder

getParserForType()

public Parser<Widget> getParserForType()
Returns
TypeDescription
Parser<Widget>
Overrides

getPieChart()

public PieChart getPieChart()

A widget that displays timeseries data as a pie chart.

.google.monitoring.dashboard.v1.PieChart pie_chart = 14;

Returns
TypeDescription
PieChart

The pieChart.

getPieChartOrBuilder()

public PieChartOrBuilder getPieChartOrBuilder()

A widget that displays timeseries data as a pie chart.

.google.monitoring.dashboard.v1.PieChart pie_chart = 14;

Returns
TypeDescription
PieChartOrBuilder

getScorecard()

public Scorecard getScorecard()

A scorecard summarizing time series data.

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

Returns
TypeDescription
Scorecard

The scorecard.

getScorecardOrBuilder()

public ScorecardOrBuilder getScorecardOrBuilder()

A scorecard summarizing time series data.

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

Returns
TypeDescription
ScorecardOrBuilder

getSectionHeader()

public SectionHeader getSectionHeader()

A widget that defines a section header for easier navigation of the dashboard.

.google.monitoring.dashboard.v1.SectionHeader section_header = 21;

Returns
TypeDescription
SectionHeader

The sectionHeader.

getSectionHeaderOrBuilder()

public SectionHeaderOrBuilder getSectionHeaderOrBuilder()

A widget that defines a section header for easier navigation of the dashboard.

.google.monitoring.dashboard.v1.SectionHeader section_header = 21;

Returns
TypeDescription
SectionHeaderOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSingleViewGroup()

public SingleViewGroup getSingleViewGroup()

A widget that groups the other widgets by using a dropdown menu.

.google.monitoring.dashboard.v1.SingleViewGroup single_view_group = 22;

Returns
TypeDescription
SingleViewGroup

The singleViewGroup.

getSingleViewGroupOrBuilder()

public SingleViewGroupOrBuilder getSingleViewGroupOrBuilder()

A widget that groups the other widgets by using a dropdown menu.

.google.monitoring.dashboard.v1.SingleViewGroup single_view_group = 22;

Returns
TypeDescription
SingleViewGroupOrBuilder

getText()

public Text getText()

A raw string or markdown displaying textual content.

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

Returns
TypeDescription
Text

The text.

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.

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.

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.

hasErrorReportingPanel()

public boolean hasErrorReportingPanel()

A widget that displays a list of error groups.

.google.monitoring.dashboard.v1.ErrorReportingPanel error_reporting_panel = 19;

Returns
TypeDescription
boolean

Whether the errorReportingPanel field is set.

hasIncidentList()

public boolean hasIncidentList()

A widget that shows list of incidents.

.google.monitoring.dashboard.v1.IncidentList incident_list = 12;

Returns
TypeDescription
boolean

Whether the incidentList 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.

hasPieChart()

public boolean hasPieChart()

A widget that displays timeseries data as a pie chart.

.google.monitoring.dashboard.v1.PieChart pie_chart = 14;

Returns
TypeDescription
boolean

Whether the pieChart 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.

hasSectionHeader()

public boolean hasSectionHeader()

A widget that defines a section header for easier navigation of the dashboard.

.google.monitoring.dashboard.v1.SectionHeader section_header = 21;

Returns
TypeDescription
boolean

Whether the sectionHeader field is set.

hasSingleViewGroup()

public boolean hasSingleViewGroup()

A widget that groups the other widgets by using a dropdown menu.

.google.monitoring.dashboard.v1.SingleViewGroup single_view_group = 22;

Returns
TypeDescription
boolean

Whether the singleViewGroup 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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides