Interface DashboardOrBuilder (2.33.0)

Version 2.33.0

• 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 interface DashboardOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getColumnLayout()

public abstract 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 abstract 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

getDashboardFilters(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
DashboardFilter

getDashboardFiltersCount()

public abstract 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
Type	Description
int

getDashboardFiltersList()

public abstract 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
Type	Description
List<DashboardFilter>

getDashboardFiltersOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
DashboardFilterOrBuilder

getDashboardFiltersOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.monitoring.dashboard.v1.DashboardFilterOrBuilder>

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels applied to the dashboard

map<string, string> labels = 12;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels applied to the dashboard

map<string, string> labels = 12;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLayoutCase()

public abstract Dashboard.LayoutCase getLayoutCase()

Returns
Type	Description
Dashboard.LayoutCase

getMosaicLayout()

public abstract 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 abstract 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 abstract 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 abstract 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.

getRowLayout()

public abstract 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 abstract 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

hasColumnLayout()

public abstract 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 abstract 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 abstract 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 abstract 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.