Class Dashboard.Builder (2.42.0)

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
TypeDescription
Descriptor

Methods

addAllDashboardFilters(Iterable<? extends DashboardFilter> values)

public Dashboard.Builder addAllDashboardFilters(Iterable<? extends DashboardFilter> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.monitoring.dashboard.v1.DashboardFilter>
Returns
TypeDescription
Dashboard.Builder

addDashboardFilters(DashboardFilter value)

public Dashboard.Builder addDashboardFilters(DashboardFilter value)

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

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

Parameter
NameDescription
valueDashboardFilter
Returns
TypeDescription
Dashboard.Builder

addDashboardFilters(DashboardFilter.Builder builderForValue)

public Dashboard.Builder addDashboardFilters(DashboardFilter.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueDashboardFilter.Builder
Returns
TypeDescription
Dashboard.Builder

addDashboardFilters(int index, DashboardFilter value)

public Dashboard.Builder addDashboardFilters(int index, DashboardFilter value)

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

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

Parameters
NameDescription
indexint
valueDashboardFilter
Returns
TypeDescription
Dashboard.Builder

addDashboardFilters(int index, DashboardFilter.Builder builderForValue)

public Dashboard.Builder addDashboardFilters(int index, DashboardFilter.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueDashboardFilter.Builder
Returns
TypeDescription
Dashboard.Builder

addDashboardFiltersBuilder()

public DashboardFilter.Builder addDashboardFiltersBuilder()

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

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

Returns
TypeDescription
DashboardFilter.Builder

addDashboardFiltersBuilder(int index)

public DashboardFilter.Builder addDashboardFiltersBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Dashboard.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Dashboard.Builder
Overrides

build()

public Dashboard build()
Returns
TypeDescription
Dashboard

buildPartial()

public Dashboard buildPartial()
Returns
TypeDescription
Dashboard

clear()

public Dashboard.Builder clear()
Returns
TypeDescription
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
TypeDescription
Dashboard.Builder

clearDashboardFilters()

public Dashboard.Builder clearDashboardFilters()

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

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

Returns
TypeDescription
Dashboard.Builder

clearDisplayName()

public Dashboard.Builder clearDisplayName()

Required. The mutable, human-readable name.

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

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Dashboard.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
Dashboard.Builder

clearLabels()

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

clearLayout()

public Dashboard.Builder clearLayout()
Returns
TypeDescription
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
TypeDescription
Dashboard.Builder

clearName()

public Dashboard.Builder clearName()

Identifier. The resource name of the dashboard.

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

Returns
TypeDescription
Dashboard.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Dashboard.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
Dashboard.Builder

clone()

public Dashboard.Builder clone()
Returns
TypeDescription
Dashboard.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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.

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

getDashboardFiltersBuilder(int index)

public DashboardFilter.Builder getDashboardFiltersBuilder(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.Builder

getDashboardFiltersBuilderList()

public List<DashboardFilter.Builder> getDashboardFiltersBuilderList()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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

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
TypeDescription
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
TypeDescription
MosaicLayoutOrBuilder

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Identifier. The resource name of the dashboard.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the dashboard.

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueColumnLayout
Returns
TypeDescription
Dashboard.Builder

mergeFrom(Dashboard other)

public Dashboard.Builder mergeFrom(Dashboard other)
Parameter
NameDescription
otherDashboard
Returns
TypeDescription
Dashboard.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Dashboard.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dashboard.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Dashboard.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueGridLayout
Returns
TypeDescription
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
NameDescription
valueMosaicLayout
Returns
TypeDescription
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
NameDescription
valueRowLayout
Returns
TypeDescription
Dashboard.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Dashboard.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Dashboard.Builder
Overrides

putAllLabels(Map<String,String> values)

public Dashboard.Builder putAllLabels(Map<String,String> values)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Dashboard.Builder

putLabels(String key, String value)

public Dashboard.Builder putLabels(String key, String value)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Dashboard.Builder

removeDashboardFilters(int index)

public Dashboard.Builder removeDashboardFilters(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
Dashboard.Builder

removeLabels(String key)

public Dashboard.Builder removeLabels(String key)

Labels applied to the dashboard

map<string, string> labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
Dashboard.Builder

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
NameDescription
valueColumnLayout
Returns
TypeDescription
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
NameDescription
builderForValueColumnLayout.Builder
Returns
TypeDescription
Dashboard.Builder

setDashboardFilters(int index, DashboardFilter value)

public Dashboard.Builder setDashboardFilters(int index, DashboardFilter value)

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

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

Parameters
NameDescription
indexint
valueDashboardFilter
Returns
TypeDescription
Dashboard.Builder

setDashboardFilters(int index, DashboardFilter.Builder builderForValue)

public Dashboard.Builder setDashboardFilters(int index, DashboardFilter.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueDashboardFilter.Builder
Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
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
NameDescription
valueString

The etag to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Dashboard.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Dashboard.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueGridLayout
Returns
TypeDescription
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
NameDescription
builderForValueGridLayout.Builder
Returns
TypeDescription
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
NameDescription
valueMosaicLayout
Returns
TypeDescription
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
NameDescription
builderForValueMosaicLayout.Builder
Returns
TypeDescription
Dashboard.Builder

setName(String value)

public Dashboard.Builder setName(String value)

Identifier. The resource name of the dashboard.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Dashboard.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Dashboard.Builder setNameBytes(ByteString value)

Identifier. The resource name of the dashboard.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueRowLayout
Returns
TypeDescription
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
NameDescription
builderForValueRowLayout.Builder
Returns
TypeDescription
Dashboard.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Dashboard.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Dashboard.Builder
Overrides