docs: Various updates

PiperOrigin-RevId: 624233552
googleapis · Apr 12, 2024 · 1413b13 · 1413b13
1 parent 1cbeafa
commit 1413b13
Show file tree

Hide file tree

Showing 12 changed files with 194 additions and 171 deletions.
diff --git a/google/monitoring/v3/alert.proto b/google/monitoring/v3/alert.proto
@@ -46,8 +46,8 @@ message AlertPolicy {
     pattern: "*"
   };
 
-  // A content string and a MIME type that describes the content string's
-  // format.
+  // Documentation that is included in the notifications and incidents
+  // pertaining to this policy.
   message Documentation {
     // The body of the documentation, interpreted according to `mime_type`.
     // The content may not exceed 8,192 Unicode characters and may not exceed
@@ -228,7 +228,8 @@ message AlertPolicy {
       Trigger trigger = 7;
 
       // A condition control that determines how metric-threshold conditions
-      // are evaluated when data stops arriving.
+      // are evaluated when data stops arriving. To use this control, the value
+      // of the `duration` field must be greater than or equal to 60 seconds.
       EvaluationMissingData evaluation_missing_data = 11;
     }
 

diff --git a/google/monitoring/v3/common.proto b/google/monitoring/v3/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -51,34 +51,44 @@ message TypedValue {
   }
 }
 
-// A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future.
+// Describes a time interval:
 //
-// * For `GAUGE` metrics, the `startTime` value is technically optional; if
-//   no value is specified, the start time defaults to the value of the
-//   end time, and the interval represents a single point in time. If both
-//   start and end times are specified, they must be identical. Such an
-//   interval is valid only for `GAUGE` metrics, which are point-in-time
-//   measurements. The end time of a new interval must be at least a
-//   millisecond after the end time of the previous interval.
-//
-// * For `DELTA` metrics, the start time and end time must specify a
-//   non-zero interval, with subsequent points specifying contiguous and
-//   non-overlapping intervals. For `DELTA` metrics, the start time of
-//   the next interval must be at least a millisecond after the end time
-//   of the previous interval.
-//
-// * For `CUMULATIVE` metrics, the start time and end time must specify a
-//   non-zero interval, with subsequent points specifying the same
-//   start time and increasing end times, until an event resets the
-//   cumulative value to zero and sets a new start time for the following
-//   points. The new start time must be at least a millisecond after the
-//   end time of the previous interval.
-//
-// * The start time of a new interval must be at least a millisecond after the
-//   end time of the previous interval because intervals are closed. If the
-//   start time of a new interval is the same as the end time of the previous
-//   interval, then data written at the new start time could overwrite data
-//   written at the previous end time.
+//   * Reads: A half-open time interval. It includes the end time but
+//     excludes the start time: `(startTime, endTime]`. The start time
+//     must be specified, must be earlier than the end time, and should be
+//     no older than the data retention period for the metric.
+//   * Writes: A closed time interval. It extends from the start time to the end
+//   time,
+//     and includes both: `[startTime, endTime]`. Valid time intervals
+//     depend on the
+//     [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind)
+//     of the metric value. The end time must not be earlier than the start
+//     time, and the end time must not be more than 25 hours in the past or more
+//     than five minutes in the future.
+//     * For `GAUGE` metrics, the `startTime` value is technically optional; if
+//       no value is specified, the start time defaults to the value of the
+//       end time, and the interval represents a single point in time. If both
+//       start and end times are specified, they must be identical. Such an
+//       interval is valid only for `GAUGE` metrics, which are point-in-time
+//       measurements. The end time of a new interval must be at least a
+//       millisecond after the end time of the previous interval.
+//     * For `DELTA` metrics, the start time and end time must specify a
+//       non-zero interval, with subsequent points specifying contiguous and
+//       non-overlapping intervals. For `DELTA` metrics, the start time of
+//       the next interval must be at least a millisecond after the end time
+//       of the previous interval.
+//     * For `CUMULATIVE` metrics, the start time and end time must specify a
+//       non-zero interval, with subsequent points specifying the same
+//       start time and increasing end times, until an event resets the
+//       cumulative value to zero and sets a new start time for the following
+//       points. The new start time must be at least a millisecond after the
+//       end time of the previous interval.
+//     * The start time of a new interval must be at least a millisecond after
+//     the
+//       end time of the previous interval because intervals are closed. If the
+//       start time of a new interval is the same as the end time of the
+//       previous interval, then data written at the new start time could
+//       overwrite data written at the previous end time.
 message TimeInterval {
   // Required. The end of the time interval.
   google.protobuf.Timestamp end_time = 2;
@@ -461,7 +471,7 @@ enum ComparisonType {
   COMPARISON_NE = 6;
 }
 
-// The tier of service for a Workspace. Please see the
+// The tier of service for a Metrics Scope. Please see the
 // [service tiers
 // documentation](https://cloud.google.com/monitoring/workspaces/tiers) for more
 // details.
@@ -472,17 +482,17 @@ enum ServiceTier {
   // been provided explicitly.
   SERVICE_TIER_UNSPECIFIED = 0;
 
-  // The Stackdriver Basic tier, a free tier of service that provides basic
+  // The Cloud Monitoring Basic tier, a free tier of service that provides basic
   // features, a moderate allotment of logs, and access to built-in metrics.
   // A number of features are not available in this tier. For more details,
   // see [the service tiers
   // documentation](https://cloud.google.com/monitoring/workspaces/tiers).
   SERVICE_TIER_BASIC = 1;
 
-  // The Stackdriver Premium tier, a higher, more expensive tier of service
-  // that provides access to all Stackdriver features, lets you use Stackdriver
-  // with AWS accounts, and has a larger allotments for logs and metrics. For
-  // more details, see [the service tiers
+  // The Cloud Monitoring Premium tier, a higher, more expensive tier of service
+  // that provides access to all Cloud Monitoring features, lets you use Cloud
+  // Monitoring with AWS accounts, and has a larger allotments for logs and
+  // metrics. For more details, see [the service tiers
   // documentation](https://cloud.google.com/monitoring/workspaces/tiers).
   SERVICE_TIER_PREMIUM = 2;
 }
diff --git a/google/monitoring/v3/dropped_labels.proto b/google/monitoring/v3/dropped_labels.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/google/monitoring/v3/group.proto b/google/monitoring/v3/group.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/google/monitoring/v3/group_service.proto b/google/monitoring/v3/group_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -96,7 +96,8 @@ service GroupService {
   }
 
   // Lists the monitored resources that are members of a group.
-  rpc ListGroupMembers(ListGroupMembersRequest) returns (ListGroupMembersResponse) {
+  rpc ListGroupMembers(ListGroupMembersRequest)
+      returns (ListGroupMembersResponse) {
     option (google.api.http) = {
       get: "/v3/{name=projects/*/groups/*}/members"
     };
@@ -106,8 +107,9 @@ service GroupService {
 
 // The `ListGroup` request.
 message ListGroupsRequest {
-  // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
-  // whose groups are to be listed. The format is:
+  // Required. The
+  // [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
+  // groups are to be listed. The format is:
   //
   //     projects/[PROJECT_ID_OR_NUMBER]
   string name = 7 [
@@ -128,8 +130,8 @@ message ListGroupsRequest {
     // Returns groups whose `parent_name` field contains the group
     // name.  If no groups have this parent, the results are empty.
     string children_of_group = 2 [(google.api.resource_reference) = {
-                                    type: "monitoring.googleapis.com/Group"
-                                  }];
+      type: "monitoring.googleapis.com/Group"
+    }];
 
     // A group name. The format is:
     //
@@ -140,8 +142,8 @@ message ListGroupsRequest {
     // ending with the most distant ancestor.  If the specified group has no
     // immediate parent, the results are empty.
     string ancestors_of_group = 3 [(google.api.resource_reference) = {
-                                     type: "monitoring.googleapis.com/Group"
-                                   }];
+      type: "monitoring.googleapis.com/Group"
+    }];
 
     // A group name. The format is:
     //
@@ -151,8 +153,8 @@ message ListGroupsRequest {
     // the results returned by the `children_of_group` filter, and includes
     // children-of-children, and so forth.
     string descendants_of_group = 4 [(google.api.resource_reference) = {
-                                       type: "monitoring.googleapis.com/Group"
-                                     }];
+      type: "monitoring.googleapis.com/Group"
+    }];
   }
 
   // A positive number that is the maximum number of results to return.
@@ -190,8 +192,9 @@ message GetGroupRequest {
 
 // The `CreateGroup` request.
 message CreateGroupRequest {
-  // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
-  // which to create the group. The format is:
+  // Required. The
+  // [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
+  // to create the group. The format is:
   //
   //     projects/[PROJECT_ID_OR_NUMBER]
   string name = 4 [
@@ -201,8 +204,8 @@ message CreateGroupRequest {
     }
   ];
 
-  // Required. A group definition. It is an error to define the `name` field because
-  // the system assigns the name.
+  // Required. A group definition. It is an error to define the `name` field
+  // because the system assigns the name.
   Group group = 2 [(google.api.field_behavior) = REQUIRED];
 
   // If true, validate this request but do not create the group.
@@ -211,8 +214,9 @@ message CreateGroupRequest {
 
 // The `UpdateGroup` request.
 message UpdateGroupRequest {
-  // Required. The new definition of the group.  All fields of the existing group,
-  // excepting `name`, are replaced with the corresponding fields of this group.
+  // Required. The new definition of the group.  All fields of the existing
+  // group, excepting `name`, are replaced with the corresponding fields of this
+  // group.
   Group group = 2 [(google.api.field_behavior) = REQUIRED];
 
   // If true, validate this request but do not update the existing group.

diff --git a/google/monitoring/v3/metric.proto b/google/monitoring/v3/metric.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.