Skip to content

Commit 0dafa39

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat:added mosaic layout
docs:clarified alignment_period max value and updated IAM docs link PiperOrigin-RevId: 362979558
1 parent a1ba456 commit 0dafa39

12 files changed

Lines changed: 79 additions & 26 deletions

‎google/monitoring/dashboard/v1/BUILD.bazel‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
# This file was automatically generated by BuildFileGenerator except for the
2-
# c++ rules at the end of the file.
1+
# This file was automatically generated by BuildFileGenerator
2+
# except for the gapic_yaml field in the java_gapic_library
3+
# and the C++ rules at the end of the file.
4+
# https://github.com/googleapis/rules_gapic/tree/master/bazel
5+
6+
# Most of the manual changes to this file will be overwritten.
7+
# It's **only** allowed to change the following rule attribute values:
8+
# - names of *_gapic_assembly_* rules
9+
# - certain parameters of *_gapic_library rules, including but not limited to:
10+
# * extra_protoc_parameters
11+
# * extra_protoc_file_parameters
12+
# The complete list of preserved parameters can be found in the source code.
313

414
# This is an API workspace, having public visibility by default makes perfect sense.
515
package(default_visibility = ["//visibility:public"])
@@ -127,6 +137,7 @@ go_gapic_library(
127137
srcs = [":dashboard_proto_with_info"],
128138
grpc_service_config = "dashboards_grpc_service_config.json",
129139
importpath = "cloud.google.com/go/monitoring/dashboard/apiv1;dashboard",
140+
metadata = True,
130141
service_yaml = "monitoring.yaml",
131142
deps = [
132143
":dashboard_go_proto",
@@ -146,6 +157,7 @@ go_gapic_assembly_pkg(
146157
name = "gapi-cloud-monitoring-dashboard-v1-go",
147158
deps = [
148159
":dashboard_go_gapic",
160+
":dashboard_go_gapic_srcjar-metadata.srcjar",
149161
":dashboard_go_gapic_srcjar-test.srcjar",
150162
":dashboard_go_proto",
151163
],
@@ -166,6 +178,7 @@ py_gapic_library(
166178
grpc_service_config = "dashboards_grpc_service_config.json",
167179
)
168180

181+
# Open Source Packages
169182
py_gapic_assembly_pkg(
170183
name = "monitoring-dashboard-v1-py",
171184
deps = [
@@ -251,8 +264,8 @@ nodejs_gapic_assembly_pkg(
251264
##############################################################################
252265
load(
253266
"@com_google_googleapis_imports//:imports.bzl",
254-
"ruby_gapic_assembly_pkg",
255267
"ruby_cloud_gapic_library",
268+
"ruby_gapic_assembly_pkg",
256269
"ruby_grpc_library",
257270
"ruby_proto_library",
258271
)
@@ -272,11 +285,11 @@ ruby_cloud_gapic_library(
272285
name = "dashboard_ruby_gapic",
273286
srcs = [":dashboard_proto_with_info"],
274287
extra_protoc_parameters = [
275-
"ruby-cloud-gem-name=google-cloud-monitoring-dashboard-v1",
276-
"ruby-cloud-env-prefix=MONITORING_DASHBOARD",
277-
"ruby-cloud-product-url=https://cloud.google.com/monitoring",
278288
"ruby-cloud-api-id=monitoring.googleapis.com",
279289
"ruby-cloud-api-shortname=monitoring",
290+
"ruby-cloud-env-prefix=MONITORING_DASHBOARD",
291+
"ruby-cloud-gem-name=google-cloud-monitoring-dashboard-v1",
292+
"ruby-cloud-product-url=https://cloud.google.com/monitoring",
280293
],
281294
grpc_service_config = "dashboards_grpc_service_config.json",
282295
ruby_cloud_description = "Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazon Web Services (AWS), hosted uptime probes, and application instrumentation. The Dashboards API manages arrangements of display widgets.",

‎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

‎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;

‎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](/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](/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/*}"

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

‎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 {

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

‎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;

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

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

0 commit comments

Comments
 (0)