com.google.api.services.monitoring.v1.model

Class Dashboard

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v1.model.Dashboard

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Dashboard
extends GenericJson

A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Dashboard()

Method Summary

Modifier and Type	Method and Description
Dashboard	clone()
ColumnLayout	getColumnLayout() The content is divided into equally spaced columns and the widgets are arranged vertically.
String	getDisplayName() Required.
String	getEtag() etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
GridLayout	getGridLayout() Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
MosaicLayout	getMosaicLayout() The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
String	getName() Immutable.
RowLayout	getRowLayout() The content is divided into equally spaced rows and the widgets are arranged horizontally.
Dashboard	set(String fieldName, Object value)
Dashboard	setColumnLayout(ColumnLayout columnLayout) The content is divided into equally spaced columns and the widgets are arranged vertically.
Dashboard	setDisplayName(String displayName) Required.
Dashboard	setEtag(String etag) etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
Dashboard	setGridLayout(GridLayout gridLayout) Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
Dashboard	setMosaicLayout(MosaicLayout mosaicLayout) The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
Dashboard	setName(String name) Immutable.
Dashboard	setRowLayout(RowLayout rowLayout) The content is divided into equally spaced rows and the widgets are arranged horizontally.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Dashboard

public Dashboard()

Method Detail

getColumnLayout

public ColumnLayout getColumnLayout()

The content is divided into equally spaced columns and the widgets are arranged vertically.

Returns:

value or null for none

setColumnLayout

public Dashboard setColumnLayout(ColumnLayout columnLayout)

The content is divided into equally spaced columns and the widgets are arranged vertically.

Parameters:

columnLayout - columnLayout or null for none

getDisplayName

public String getDisplayName()

Required. The mutable, human-readable name.

Returns:

value or null for none

setDisplayName

public Dashboard setDisplayName(String displayName)

Required. The mutable, human-readable name.

Parameters:

displayName - displayName or null for none

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.

Returns:

value or null for none

setEtag

public Dashboard setEtag(String etag)

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.

Parameters:

etag - etag or null for none

getGridLayout

public GridLayout getGridLayout()

Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.

Returns:

value or null for none

setGridLayout

public Dashboard setGridLayout(GridLayout gridLayout)

Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.

Parameters:

gridLayout - gridLayout or null for none

getMosaicLayout

public MosaicLayout getMosaicLayout()

The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.

Returns:

value or null for none

setMosaicLayout

public Dashboard setMosaicLayout(MosaicLayout mosaicLayout)

The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.

Parameters:

mosaicLayout - mosaicLayout or null for none

getName

public String getName()

Immutable. The resource name of the dashboard.

Returns:

value or null for none

setName

public Dashboard setName(String name)

Immutable. The resource name of the dashboard.

Parameters:

name - name or null for none

getRowLayout

public RowLayout getRowLayout()

The content is divided into equally spaced rows and the widgets are arranged horizontally.

Returns:

value or null for none

setRowLayout

public Dashboard setRowLayout(RowLayout rowLayout)

The content is divided into equally spaced rows and the widgets are arranged horizontally.

Parameters:

rowLayout - rowLayout or null for none

set

public Dashboard set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public Dashboard clone()

Overrides:

clone in class GenericJson