- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.6
- 2.4.0
- 2.3.0
- 2.2.6
public final class Widget extends GeneratedMessageV3 implements WidgetOrBuilderWidget contains a single dashboard component and configuration of how to present the component in the dashboard.
Protobuf type google.monitoring.dashboard.v1.Widget
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WidgetImplements
WidgetOrBuilderStatic Fields
ALERT_CHART_FIELD_NUMBER
public static final int ALERT_CHART_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BLANK_FIELD_NUMBER
public static final int BLANK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
COLLAPSIBLE_GROUP_FIELD_NUMBER
public static final int COLLAPSIBLE_GROUP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ERROR_REPORTING_PANEL_FIELD_NUMBER
public static final int ERROR_REPORTING_PANEL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INCIDENT_LIST_FIELD_NUMBER
public static final int INCIDENT_LIST_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LOGS_PANEL_FIELD_NUMBER
public static final int LOGS_PANEL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PIE_CHART_FIELD_NUMBER
public static final int PIE_CHART_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SCORECARD_FIELD_NUMBER
public static final int SCORECARD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SECTION_HEADER_FIELD_NUMBER
public static final int SECTION_HEADER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SINGLE_VIEW_GROUP_FIELD_NUMBER
public static final int SINGLE_VIEW_GROUP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TIME_SERIES_TABLE_FIELD_NUMBER
public static final int TIME_SERIES_TABLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
XY_CHART_FIELD_NUMBER
public static final int XY_CHART_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Widget getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Widget |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Widget.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Widget.Builder |
|
newBuilder(Widget prototype)
public static Widget.Builder newBuilder(Widget prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Widget |
| Returns | |
|---|---|
| Type | Description |
Widget.Builder |
|
parseDelimitedFrom(InputStream input)
public static Widget parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Widget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Widget parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Widget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Widget parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Widget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Widget parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Widget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Widget parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Widget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Widget parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Widget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Widget |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Widget> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Widget> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAlertChart()
public AlertChart getAlertChart()A chart of alert policy data.
.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;
| Returns | |
|---|---|
| Type | Description |
AlertChart |
The alertChart. |
getAlertChartOrBuilder()
public AlertChartOrBuilder getAlertChartOrBuilder()A chart of alert policy data.
.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;
| Returns | |
|---|---|
| Type | Description |
AlertChartOrBuilder |
|
getBlank()
public Empty getBlank()A blank space.
.google.protobuf.Empty blank = 5;
| Returns | |
|---|---|
| Type | Description |
Empty |
The blank. |
getBlankOrBuilder()
public EmptyOrBuilder getBlankOrBuilder()A blank space.
.google.protobuf.Empty blank = 5;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
CollapsibleGroupOrBuilder |
|
getContentCase()
public Widget.ContentCase getContentCase()| Returns | |
|---|---|
| Type | Description |
Widget.ContentCase |
|
getDefaultInstanceForType()
public Widget getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Widget |
|
getErrorReportingPanel()
public ErrorReportingPanel getErrorReportingPanel()A widget that displays a list of error groups.
.google.monitoring.dashboard.v1.ErrorReportingPanel error_reporting_panel = 19;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
IncidentList |
The incidentList. |
getIncidentListOrBuilder()
public IncidentListOrBuilder getIncidentListOrBuilder()A widget that shows list of incidents.
.google.monitoring.dashboard.v1.IncidentList incident_list = 12;
| Returns | |
|---|---|
| Type | Description |
IncidentListOrBuilder |
|
getLogsPanel()
public LogsPanel getLogsPanel()A widget that shows a stream of logs.
.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;
| Returns | |
|---|---|
| Type | Description |
LogsPanel |
The logsPanel. |
getLogsPanelOrBuilder()
public LogsPanelOrBuilder getLogsPanelOrBuilder()A widget that shows a stream of logs.
.google.monitoring.dashboard.v1.LogsPanel logs_panel = 10;
| Returns | |
|---|---|
| Type | Description |
LogsPanelOrBuilder |
|
getParserForType()
public Parser<Widget> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Widget> |
|
getPieChart()
public PieChart getPieChart()A widget that displays timeseries data as a pie chart.
.google.monitoring.dashboard.v1.PieChart pie_chart = 14;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
PieChartOrBuilder |
|
getScorecard()
public Scorecard getScorecard()A scorecard summarizing time series data.
.google.monitoring.dashboard.v1.Scorecard scorecard = 3;
| Returns | |
|---|---|
| Type | Description |
Scorecard |
The scorecard. |
getScorecardOrBuilder()
public ScorecardOrBuilder getScorecardOrBuilder()A scorecard summarizing time series data.
.google.monitoring.dashboard.v1.Scorecard scorecard = 3;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
SectionHeaderOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
SingleViewGroupOrBuilder |
|
getText()
public Text getText()A raw string or markdown displaying textual content.
.google.monitoring.dashboard.v1.Text text = 4;
| Returns | |
|---|---|
| Type | Description |
Text |
The text. |
getTextOrBuilder()
public TextOrBuilder getTextOrBuilder()A raw string or markdown displaying textual content.
.google.monitoring.dashboard.v1.Text text = 4;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimeSeriesTableOrBuilder |
|
getTitle()
public String getTitle()Optional. The title of the widget.
string title = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public ByteString getTitleBytes()Optional. The title of the widget.
string title = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
getXyChart()
public XyChart getXyChart()A chart of time series data.
.google.monitoring.dashboard.v1.XyChart xy_chart = 2;
| Returns | |
|---|---|
| Type | Description |
XyChart |
The xyChart. |
getXyChartOrBuilder()
public XyChartOrBuilder getXyChartOrBuilder()A chart of time series data.
.google.monitoring.dashboard.v1.XyChart xy_chart = 2;
| Returns | |
|---|---|
| Type | Description |
XyChartOrBuilder |
|
hasAlertChart()
public boolean hasAlertChart()A chart of alert policy data.
.google.monitoring.dashboard.v1.AlertChart alert_chart = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the alertChart field is set. |
hasBlank()
public boolean hasBlank()A blank space.
.google.protobuf.Empty blank = 5;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the xyChart field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Widget.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Widget.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Widget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Widget.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Widget.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Widget.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|