Class Dashboard (2.2.6)
Version 2.2.6keyboard_arrow_down
public final class Dashboard extends GeneratedMessageV3 implements DashboardOrBuilder
A Google Stackdriver dashboard. Dashboards define the content and layout
of pages in the Stackdriver web application.
Protobuf type google.monitoring.dashboard.v1.Dashboard
Static Fields
COLUMN_LAYOUT_FIELD_NUMBER
public static final int COLUMN_LAYOUT_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
GRID_LAYOUT_FIELD_NUMBER
public static final int GRID_LAYOUT_FIELD_NUMBER
Field Value
MOSAIC_LAYOUT_FIELD_NUMBER
public static final int MOSAIC_LAYOUT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
ROW_LAYOUT_FIELD_NUMBER
public static final int ROW_LAYOUT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Dashboard getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Dashboard . Builder newBuilder ()
Returns
newBuilder(Dashboard prototype)
public static Dashboard . Builder newBuilder ( Dashboard prototype )
Parameter
Returns
public static Dashboard parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Dashboard parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Dashboard parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Dashboard parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Dashboard parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Dashboard parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Dashboard parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Dashboard parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Dashboard parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Dashboard> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getColumnLayout()
public ColumnLayout getColumnLayout ()
The content is divided into equally spaced columns and the widgets are
arranged vertically.
.google.monitoring.dashboard.v1.ColumnLayout column_layout = 9;
Returns
getColumnLayoutOrBuilder()
public ColumnLayoutOrBuilder getColumnLayoutOrBuilder ()
The content is divided into equally spaced columns and the widgets are
arranged vertically.
.google.monitoring.dashboard.v1.ColumnLayout column_layout = 9;
Returns
getDefaultInstanceForType()
public Dashboard getDefaultInstanceForType ()
Returns
getDisplayName()
public String getDisplayName ()
Required. The mutable, human-readable name.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
Required. The mutable, human-readable name.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for displayName.
getEtag()
etag is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other.
An etag is returned in the response to GetDashboard, and
users are expected to put that etag in the request to UpdateDashboard to
ensure that their change will be applied to the same version of the
Dashboard configuration. The field should not be passed during
dashboard creation.
string etag = 4;
Returns
Type Description
String The etag.
getEtagBytes()
public ByteString getEtagBytes ()
etag is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other.
An etag is returned in the response to GetDashboard, and
users are expected to put that etag in the request to UpdateDashboard to
ensure that their change will be applied to the same version of the
Dashboard configuration. The field should not be passed during
dashboard creation.
string etag = 4;
Returns
getGridLayout()
public GridLayout getGridLayout ()
Content is arranged with a basic layout that re-flows a simple list of
informational elements like widgets or tiles.
.google.monitoring.dashboard.v1.GridLayout grid_layout = 5;
Returns
getGridLayoutOrBuilder()
public GridLayoutOrBuilder getGridLayoutOrBuilder ()
Content is arranged with a basic layout that re-flows a simple list of
informational elements like widgets or tiles.
.google.monitoring.dashboard.v1.GridLayout grid_layout = 5;
Returns
getLayoutCase()
public Dashboard . LayoutCase getLayoutCase ()
Returns
getMosaicLayout()
public MosaicLayout getMosaicLayout ()
The content is arranged as a grid of tiles, with each content widget
occupying one or more grid blocks.
.google.monitoring.dashboard.v1.MosaicLayout mosaic_layout = 6;
Returns
getMosaicLayoutOrBuilder()
public MosaicLayoutOrBuilder getMosaicLayoutOrBuilder ()
The content is arranged as a grid of tiles, with each content widget
occupying one or more grid blocks.
.google.monitoring.dashboard.v1.MosaicLayout mosaic_layout = 6;
Returns
getName()
Immutable. The resource name of the dashboard.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Immutable. The resource name of the dashboard.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns
getParserForType()
public Parser<Dashboard> getParserForType ()
Returns
Overrides
getRowLayout()
public RowLayout getRowLayout ()
The content is divided into equally spaced rows and the widgets are
arranged horizontally.
.google.monitoring.dashboard.v1.RowLayout row_layout = 8;
Returns
getRowLayoutOrBuilder()
public RowLayoutOrBuilder getRowLayoutOrBuilder ()
The content is divided into equally spaced rows and the widgets are
arranged horizontally.
.google.monitoring.dashboard.v1.RowLayout row_layout = 8;
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasColumnLayout()
public boolean hasColumnLayout ()
The content is divided into equally spaced columns and the widgets are
arranged vertically.
.google.monitoring.dashboard.v1.ColumnLayout column_layout = 9;
Returns
Type Description
boolean Whether the columnLayout field is set.
hasGridLayout()
public boolean hasGridLayout ()
Content is arranged with a basic layout that re-flows a simple list of
informational elements like widgets or tiles.
.google.monitoring.dashboard.v1.GridLayout grid_layout = 5;
Returns
Type Description
boolean Whether the gridLayout field is set.
hasMosaicLayout()
public boolean hasMosaicLayout ()
The content is arranged as a grid of tiles, with each content widget
occupying one or more grid blocks.
.google.monitoring.dashboard.v1.MosaicLayout mosaic_layout = 6;
Returns
Type Description
boolean Whether the mosaicLayout field is set.
hasRowLayout()
public boolean hasRowLayout ()
The content is divided into equally spaced rows and the widgets are
arranged horizontally.
.google.monitoring.dashboard.v1.RowLayout row_layout = 8;
Returns
Type Description
boolean Whether the rowLayout field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Dashboard . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Dashboard . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Dashboard . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
