Class Widget (2.3.0)

Version 2.3.0

• 2.43.0 (latest)
• 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 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Widget

Implements

WidgetOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

LOGS_PANEL_FIELD_NUMBER

public static final int LOGS_PANEL_FIELD_NUMBER

Field Value

Type	Description
int

SCORECARD_FIELD_NUMBER

public static final int SCORECARD_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

Overrides

AbstractMessage.equals(Object other)

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

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>

Overrides

GeneratedMessageV3.getParserForType()

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

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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.

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.

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.

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

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Widget.Builder toBuilder()

Returns

Type	Description
Widget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException