Skip to content

Commit b9426fe

Browse files
feat:added mosaic layout docs:clarified alignment_period max value and updated IAM docs link (#152)
* feat:added mosaic layout docs:clarified alignment_period max value and updated IAM docs link PiperOrigin-RevId: 362979558 Source-Author: Google APIs <[email protected]> Source-Date: Mon Mar 15 10:55:19 2021 -0700 Source-Repo: googleapis/googleapis Source-Sha: 0dafa3963ef6fcb8a7f5daaa4bec12adb04de518 Source-Link: googleapis/googleapis@0dafa39 * build: update links from relative to absolute to pass docs tests PiperOrigin-RevId: 363712862 Source-Author: Google APIs <[email protected]> Source-Date: Thu Mar 18 12:06:46 2021 -0700 Source-Repo: googleapis/googleapis Source-Sha: 4f5e3aeabb80833f0cfd6dd570a7b18787d3a844 Source-Link: googleapis/googleapis@4f5e3ae
1 parent 56a7baf commit b9426fe

File tree

16 files changed

+881
-35
lines changed

16 files changed

+881
-35
lines changed

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/common.proto

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -316,6 +316,8 @@ message Aggregation {
316316
// `ALIGN_NONE` is specified, this field is required or an error is returned.
317317
// If no per-series aligner is specified, or the aligner `ALIGN_NONE` is
318318
// specified, then this field is ignored.
319+
//
320+
// The maximum value of the `alignment_period` is 2 years, or 104 weeks.
319321
google.protobuf.Duration alignment_period = 1;
320322

321323
// An `Aligner` describes how to bring the data points in a single

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/dashboard.proto

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -55,6 +55,10 @@ message Dashboard {
5555
// informational elements like widgets or tiles.
5656
GridLayout grid_layout = 5;
5757

58+
// The content is arranged as a grid of tiles, with each content widget
59+
// occupying one or more grid blocks.
60+
MosaicLayout mosaic_layout = 6;
61+
5862
// The content is divided into equally spaced rows and the widgets are
5963
// arranged horizontally.
6064
RowLayout row_layout = 8;

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/dashboards_service.proto

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -40,11 +40,8 @@ service DashboardsService {
4040
"https://www.googleapis.com/auth/monitoring.read,"
4141
"https://www.googleapis.com/auth/monitoring.write";
4242

43-
// Creates a new custom dashboard.
44-
//
45-
// This method requires the `monitoring.dashboards.create` permission
46-
// on the specified project. For more information, see
47-
// [Google Cloud IAM](https://cloud.google.com/iam).
43+
// Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard).
44+
// This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
4845
rpc CreateDashboard(CreateDashboardRequest) returns (Dashboard) {
4946
option (google.api.http) = {
5047
post: "/v1/{parent=projects/*}/dashboards"
@@ -56,7 +53,7 @@ service DashboardsService {
5653
//
5754
// This method requires the `monitoring.dashboards.list` permission
5855
// on the specified project. For more information, see
59-
// [Google Cloud IAM](https://cloud.google.com/iam).
56+
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
6057
rpc ListDashboards(ListDashboardsRequest) returns (ListDashboardsResponse) {
6158
option (google.api.http) = {
6259
get: "/v1/{parent=projects/*}/dashboards"
@@ -67,7 +64,7 @@ service DashboardsService {
6764
//
6865
// This method requires the `monitoring.dashboards.get` permission
6966
// on the specified dashboard. For more information, see
70-
// [Google Cloud IAM](https://cloud.google.com/iam).
67+
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
7168
rpc GetDashboard(GetDashboardRequest) returns (Dashboard) {
7269
option (google.api.http) = {
7370
get: "/v1/{name=projects/*/dashboards/*}"
@@ -78,7 +75,7 @@ service DashboardsService {
7875
//
7976
// This method requires the `monitoring.dashboards.delete` permission
8077
// on the specified dashboard. For more information, see
81-
// [Google Cloud IAM](https://cloud.google.com/iam).
78+
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
8279
rpc DeleteDashboard(DeleteDashboardRequest) returns (google.protobuf.Empty) {
8380
option (google.api.http) = {
8481
delete: "/v1/{name=projects/*/dashboards/*}"
@@ -89,7 +86,7 @@ service DashboardsService {
8986
//
9087
// This method requires the `monitoring.dashboards.update` permission
9188
// on the specified dashboard. For more information, see
92-
// [Google Cloud IAM](https://cloud.google.com/iam).
89+
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
9390
rpc UpdateDashboard(UpdateDashboardRequest) returns (Dashboard) {
9491
option (google.api.http) = {
9592
patch: "/v1/{dashboard.name=projects/*/dashboards/*}"

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/drilldowns.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/layouts.proto

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -35,6 +35,42 @@ message GridLayout {
3535
repeated Widget widgets = 2;
3636
}
3737

38+
// A mosaic layout divides the available space into a grid of blocks, and
39+
// overlays the grid with tiles. Unlike `GridLayout`, tiles may span multiple
40+
// grid blocks and can be placed at arbitrary locations in the grid.
41+
message MosaicLayout {
42+
// A single tile in the mosaic. The placement and size of the tile are
43+
// configurable.
44+
message Tile {
45+
// The zero-indexed position of the tile in grid blocks relative to the
46+
// left edge of the grid. Tiles must be contained within the specified
47+
// number of columns. `x_pos` cannot be negative.
48+
int32 x_pos = 1;
49+
50+
// The zero-indexed position of the tile in grid blocks relative to the
51+
// top edge of the grid. `y_pos` cannot be negative.
52+
int32 y_pos = 2;
53+
54+
// The width of the tile, measured in grid blocks. Tiles must have a
55+
// minimum width of 1.
56+
int32 width = 3;
57+
58+
// The height of the tile, measured in grid blocks. Tiles must have a
59+
// minimum height of 1.
60+
int32 height = 4;
61+
62+
// The informational widget contained in the tile. For example an `XyChart`.
63+
Widget widget = 5;
64+
}
65+
66+
// The number of columns in the mosaic grid. The number of columns must be
67+
// between 1 and 12, inclusive.
68+
int32 columns = 1;
69+
70+
// The tiles to display.
71+
repeated Tile tiles = 3;
72+
}
73+
3874
// A simplified layout that divides the available space into rows
3975
// and arranges a set of widgets horizontally in each row.
4076
message RowLayout {

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/metrics.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/scorecard.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@ package google.monitoring.dashboard.v1;
1919
import "google/api/field_behavior.proto";
2020
import "google/monitoring/dashboard/v1/metrics.proto";
2121
import "google/protobuf/duration.proto";
22+
import "google/protobuf/empty.proto";
2223

2324
option go_package = "google.golang.org/genproto/googleapis/monitoring/dashboard/v1;dashboard";
2425
option java_multiple_files = true;

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/service.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/text.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

packages/google-monitoring-dashboard/protos/google/monitoring/dashboard/v1/widget.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)