Class Dashboard (2.35.0)

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

Implements

DashboardOrBuilder

Static Fields

COLUMN_LAYOUT_FIELD_NUMBER

public static final int COLUMN_LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

DASHBOARD_FILTERS_FIELD_NUMBER

public static final int DASHBOARD_FILTERS_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

GRID_LAYOUT_FIELD_NUMBER

public static final int GRID_LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MOSAIC_LAYOUT_FIELD_NUMBER

public static final int MOSAIC_LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_LAYOUT_FIELD_NUMBER

public static final int ROW_LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Dashboard getDefaultInstance()
Returns
TypeDescription
Dashboard

getDescriptor()

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

newBuilder()

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

newBuilder(Dashboard prototype)

public static Dashboard.Builder newBuilder(Dashboard prototype)
Parameter
NameDescription
prototypeDashboard
Returns
TypeDescription
Dashboard.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ColumnLayoutOrBuilder

getDashboardFilters(int index)

public DashboardFilter getDashboardFilters(int index)

Filters to reduce the amount of data charted based on the filter criteria.

repeated .google.monitoring.dashboard.v1.DashboardFilter dashboard_filters = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
DashboardFilter

getDashboardFiltersCount()

public int getDashboardFiltersCount()

Filters to reduce the amount of data charted based on the filter criteria.

repeated .google.monitoring.dashboard.v1.DashboardFilter dashboard_filters = 11;

Returns
TypeDescription
int

getDashboardFiltersList()

public List<DashboardFilter> getDashboardFiltersList()

Filters to reduce the amount of data charted based on the filter criteria.

repeated .google.monitoring.dashboard.v1.DashboardFilter dashboard_filters = 11;

Returns
TypeDescription
List<DashboardFilter>

getDashboardFiltersOrBuilder(int index)

public DashboardFilterOrBuilder getDashboardFiltersOrBuilder(int index)

Filters to reduce the amount of data charted based on the filter criteria.

repeated .google.monitoring.dashboard.v1.DashboardFilter dashboard_filters = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
DashboardFilterOrBuilder

getDashboardFiltersOrBuilderList()

public List<? extends DashboardFilterOrBuilder> getDashboardFiltersOrBuilderList()

Filters to reduce the amount of data charted based on the filter criteria.

repeated .google.monitoring.dashboard.v1.DashboardFilter dashboard_filters = 11;

Returns
TypeDescription
List<? extends com.google.monitoring.dashboard.v1.DashboardFilterOrBuilder>

getDefaultInstanceForType()

public Dashboard getDefaultInstanceForType()
Returns
TypeDescription
Dashboard

getDisplayName()

public String getDisplayName()

Required. The mutable, human-readable name.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The mutable, human-readable name.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
GridLayoutOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels applied to the dashboard

map<string, string> labels = 12;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels applied to the dashboard

map<string, string> labels = 12;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLayoutCase()

public Dashboard.LayoutCase getLayoutCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
MosaicLayoutOrBuilder

getName()

public String getName()

Immutable. The resource name of the dashboard.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The resource name of the dashboard.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Dashboard> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RowLayoutOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the rowLayout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Dashboard.Builder newBuilderForType()
Returns
TypeDescription
Dashboard.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Dashboard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Dashboard.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Dashboard.Builder toBuilder()
Returns
TypeDescription
Dashboard.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException