Class Dashboard (2.2.6) 

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

Inheritance

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

Implements

DashboardOrBuilder

Static Fields

COLUMN_LAYOUT_FIELD_NUMBER

public static final int COLUMN_LAYOUT_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

GRID_LAYOUT_FIELD_NUMBER

public static final int GRID_LAYOUT_FIELD_NUMBER
Field Value
Type Description
int

MOSAIC_LAYOUT_FIELD_NUMBER

public static final int MOSAIC_LAYOUT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ROW_LAYOUT_FIELD_NUMBER

public static final int ROW_LAYOUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Dashboard getDefaultInstance()
Returns
Type Description
Dashboard

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Dashboard.Builder newBuilder()
Returns
Type Description
Dashboard.Builder

newBuilder(Dashboard prototype)

public static Dashboard.Builder newBuilder(Dashboard prototype)
Parameter
Name Description
prototype Dashboard
Returns
Type Description
Dashboard.Builder

parseDelimitedFrom(InputStream input)

public static Dashboard parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Dashboard
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Dashboard parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Dashboard parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Dashboard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Dashboard parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Dashboard parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Dashboard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Dashboard parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Dashboard parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Dashboard
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Dashboard parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Dashboard parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Dashboard
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Dashboard parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Dashboard parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Dashboard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Dashboard parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Dashboard> parser()
Returns
Type Description
Parser<Dashboard>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
ColumnLayout

The columnLayout.

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
Type Description
ColumnLayoutOrBuilder

getDefaultInstanceForType()

public Dashboard getDefaultInstanceForType()
Returns
Type Description
Dashboard

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()

public String 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
Type Description
ByteString

The bytes for etag.

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
Type Description
GridLayout

The gridLayout.

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
Type Description
GridLayoutOrBuilder

getLayoutCase()

public Dashboard.LayoutCase getLayoutCase()
Returns
Type Description
Dashboard.LayoutCase

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
Type Description
MosaicLayout

The mosaicLayout.

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
Type Description
MosaicLayoutOrBuilder

getName()

public String 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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Dashboard> getParserForType()
Returns
Type Description
Parser<Dashboard>
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
Type Description
RowLayout

The rowLayout.

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
Type Description
RowLayoutOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Dashboard.Builder newBuilderForType()
Returns
Type Description
Dashboard.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Dashboard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Dashboard.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Dashboard.Builder toBuilder()
Returns
Type Description
Dashboard.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException