Class Dashboard.Builder (2.2.6)

public static final class Dashboard.Builder extends GeneratedMessageV3.Builder<Dashboard.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Dashboard.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Dashboard.Builder
Overrides

build()

public Dashboard build()
Returns
Type Description
Dashboard

buildPartial()

public Dashboard buildPartial()
Returns
Type Description
Dashboard

clear()

public Dashboard.Builder clear()
Returns
Type Description
Dashboard.Builder
Overrides

clearColumnLayout()

public Dashboard.Builder clearColumnLayout()

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
Dashboard.Builder

clearDisplayName()

public Dashboard.Builder clearDisplayName()

Required. The mutable, human-readable name.

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

Returns
Type Description
Dashboard.Builder

This builder for chaining.

clearEtag()

public Dashboard.Builder clearEtag()

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
Dashboard.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Dashboard.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Dashboard.Builder
Overrides

clearGridLayout()

public Dashboard.Builder clearGridLayout()

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
Dashboard.Builder

clearLayout()

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

clearMosaicLayout()

public Dashboard.Builder clearMosaicLayout()

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
Dashboard.Builder

clearName()

public Dashboard.Builder clearName()

Immutable. The resource name of the dashboard.

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

Returns
Type Description
Dashboard.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Dashboard.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Dashboard.Builder
Overrides

clearRowLayout()

public Dashboard.Builder clearRowLayout()

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
Dashboard.Builder

clone()

public Dashboard.Builder clone()
Returns
Type Description
Dashboard.Builder
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.

getColumnLayoutBuilder()

public ColumnLayout.Builder getColumnLayoutBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getGridLayoutBuilder()

public GridLayout.Builder getGridLayoutBuilder()

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.Builder

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.

getMosaicLayoutBuilder()

public MosaicLayout.Builder getMosaicLayoutBuilder()

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.Builder

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.

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.

getRowLayoutBuilder()

public RowLayout.Builder getRowLayoutBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeColumnLayout(ColumnLayout value)

public Dashboard.Builder mergeColumnLayout(ColumnLayout value)

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

.google.monitoring.dashboard.v1.ColumnLayout column_layout = 9;

Parameter
Name Description
value ColumnLayout
Returns
Type Description
Dashboard.Builder

mergeFrom(Dashboard other)

public Dashboard.Builder mergeFrom(Dashboard other)
Parameter
Name Description
other Dashboard
Returns
Type Description
Dashboard.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Dashboard.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Dashboard.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Dashboard.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Dashboard.Builder
Overrides

mergeGridLayout(GridLayout value)

public Dashboard.Builder mergeGridLayout(GridLayout value)

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;

Parameter
Name Description
value GridLayout
Returns
Type Description
Dashboard.Builder

mergeMosaicLayout(MosaicLayout value)

public Dashboard.Builder mergeMosaicLayout(MosaicLayout value)

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;

Parameter
Name Description
value MosaicLayout
Returns
Type Description
Dashboard.Builder

mergeRowLayout(RowLayout value)

public Dashboard.Builder mergeRowLayout(RowLayout value)

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

.google.monitoring.dashboard.v1.RowLayout row_layout = 8;

Parameter
Name Description
value RowLayout
Returns
Type Description
Dashboard.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Dashboard.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Dashboard.Builder
Overrides

setColumnLayout(ColumnLayout value)

public Dashboard.Builder setColumnLayout(ColumnLayout value)

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

.google.monitoring.dashboard.v1.ColumnLayout column_layout = 9;

Parameter
Name Description
value ColumnLayout
Returns
Type Description
Dashboard.Builder

setColumnLayout(ColumnLayout.Builder builderForValue)

public Dashboard.Builder setColumnLayout(ColumnLayout.Builder builderForValue)

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

.google.monitoring.dashboard.v1.ColumnLayout column_layout = 9;

Parameter
Name Description
builderForValue ColumnLayout.Builder
Returns
Type Description
Dashboard.Builder

setDisplayName(String value)

public Dashboard.Builder setDisplayName(String value)

Required. The mutable, human-readable name.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Dashboard.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Dashboard.Builder setDisplayNameBytes(ByteString value)

Required. The mutable, human-readable name.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Dashboard.Builder

This builder for chaining.

setEtag(String value)

public Dashboard.Builder setEtag(String value)

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;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Dashboard.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Dashboard.Builder setEtagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Dashboard.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Dashboard.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Dashboard.Builder
Overrides

setGridLayout(GridLayout value)

public Dashboard.Builder setGridLayout(GridLayout value)

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;

Parameter
Name Description
value GridLayout
Returns
Type Description
Dashboard.Builder

setGridLayout(GridLayout.Builder builderForValue)

public Dashboard.Builder setGridLayout(GridLayout.Builder builderForValue)

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;

Parameter
Name Description
builderForValue GridLayout.Builder
Returns
Type Description
Dashboard.Builder

setMosaicLayout(MosaicLayout value)

public Dashboard.Builder setMosaicLayout(MosaicLayout value)

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;

Parameter
Name Description
value MosaicLayout
Returns
Type Description
Dashboard.Builder

setMosaicLayout(MosaicLayout.Builder builderForValue)

public Dashboard.Builder setMosaicLayout(MosaicLayout.Builder builderForValue)

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;

Parameter
Name Description
builderForValue MosaicLayout.Builder
Returns
Type Description
Dashboard.Builder

setName(String value)

public Dashboard.Builder setName(String value)

Immutable. The resource name of the dashboard.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Dashboard.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Dashboard.Builder setNameBytes(ByteString value)

Immutable. The resource name of the dashboard.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Dashboard.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Dashboard.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Dashboard.Builder
Overrides

setRowLayout(RowLayout value)

public Dashboard.Builder setRowLayout(RowLayout value)

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

.google.monitoring.dashboard.v1.RowLayout row_layout = 8;

Parameter
Name Description
value RowLayout
Returns
Type Description
Dashboard.Builder

setRowLayout(RowLayout.Builder builderForValue)

public Dashboard.Builder setRowLayout(RowLayout.Builder builderForValue)

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

.google.monitoring.dashboard.v1.RowLayout row_layout = 8;

Parameter
Name Description
builderForValue RowLayout.Builder
Returns
Type Description
Dashboard.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Dashboard.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Dashboard.Builder
Overrides