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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLUMN_LAYOUT_FIELD_NUMBER
public static final int COLUMN_LAYOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DASHBOARD_FILTERS_FIELD_NUMBER
public static final int DASHBOARD_FILTERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GRID_LAYOUT_FIELD_NUMBER
public static final int GRID_LAYOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MOSAIC_LAYOUT_FIELD_NUMBER
public static final int MOSAIC_LAYOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROW_LAYOUT_FIELD_NUMBER
public static final int ROW_LAYOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Dashboard getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Dashboard.Builder newBuilder()
newBuilder(Dashboard prototype)
public static Dashboard.Builder newBuilder(Dashboard prototype)
| Parameter |
| Name |
Description |
prototype |
Dashboard
|
public static Dashboard parseDelimitedFrom(InputStream input)
public static Dashboard parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Dashboard parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Dashboard parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom(CodedInputStream input)
public static Dashboard parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom(InputStream input)
public static Dashboard parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Dashboard parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Dashboard parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Dashboard> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels applied to the dashboard
map<string, string> labels = 12;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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;
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;
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
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;
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
List<? extends com.google.monitoring.dashboard.v1.DashboardFilterOrBuilder> |
|
getDefaultInstanceForType()
public Dashboard getDefaultInstanceForType()
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()
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.
|
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;
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Labels applied to the dashboard
map<string, string> labels = 12;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels applied to the dashboard
map<string, string> labels = 12;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels applied to the dashboard
map<string, string> labels = 12;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public 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 Dashboard.LayoutCase getLayoutCase()
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;
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;
getName()
Identifier. The resource name of the dashboard.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the dashboard.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Dashboard> getParserForType()
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 |
| Type |
Description |
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
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 |
| 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Dashboard.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Dashboard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Dashboard.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
