Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

docs: update proto comments #159

Merged
merged 1 commit into from
Nov 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/alert.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/alert_service.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
11 changes: 6 additions & 5 deletions protos/google/monitoring/v3/common.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down Expand Up @@ -391,8 +392,8 @@ enum ComparisonType {
COMPARISON_NE = 6;
}

// The tier of service for a Stackdriver account. Please see the
// [service tiers documentation](https://cloud.google.com/monitoring/accounts/tiers)
// The tier of service for a Workspace. Please see the
// [service tiers documentation](https://cloud.google.com/monitoring/workspaces/tiers)
// for more details.
enum ServiceTier {
option deprecated = true;
Expand All @@ -404,12 +405,12 @@ enum ServiceTier {
// The Stackdriver 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/accounts/tiers).
// 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 documentation](https://cloud.google.com/monitoring/accounts/tiers).
// more details, see [the service tiers documentation](https://cloud.google.com/monitoring/workspaces/tiers).
SERVICE_TIER_PREMIUM = 2;
}
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/dropped_labels.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/group.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/group_service.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/metric.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
4 changes: 2 additions & 2 deletions protos/google/monitoring/v3/metric_service.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down Expand Up @@ -236,7 +237,6 @@ message ListTimeSeriesRequest {
//
// metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
// metric.label.instance_name = "my-instance-name"
//
string filter = 2;

// The time interval for which results should be returned. Only time series
Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/mutation_record.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/notification.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
6 changes: 4 additions & 2 deletions protos/google/monitoring/v3/notification_service.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand All @@ -20,6 +21,7 @@ import "google/api/annotations.proto";
import "google/monitoring/v3/notification.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";

option csharp_namespace = "Google.Cloud.Monitoring.V3";
Expand Down Expand Up @@ -68,7 +70,7 @@ service NotificationChannelService {
}

// Creates a new notification channel, representing a single notification
// endpoint such as an email address, SMS number, or pagerduty service.
// endpoint such as an email address, SMS number, or PagerDuty service.
rpc CreateNotificationChannel(CreateNotificationChannelRequest) returns (NotificationChannel) {
option (google.api.http) = {
post: "/v3/{name=projects/*}/notificationChannels"
Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/span_context.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
54 changes: 34 additions & 20 deletions protos/google/monitoring/v3/uptime.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand All @@ -27,24 +28,34 @@ option java_package = "com.google.monitoring.v3";
option php_namespace = "Google\\Cloud\\Monitoring\\V3";


// Nimbus InternalCheckers.
// An internal checker allows uptime checks to run on private/internal GCP
// resources.
message InternalChecker {
// The GCP project ID. Not necessarily the same as the project_id for the
// config.
string project_id = 1;
// A unique resource name for this InternalChecker. The format is:
//
//
// `projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID]`.
//
// PROJECT_ID is the stackdriver workspace project for the
// uptime check config associated with the internal checker.
string name = 1;

// The checker's human-readable name. The display name
// should be unique within a Stackdriver Workspace in order to make it easier
// to identify; however, uniqueness is not enforced.
string display_name = 2;

// The internal network to perform this uptime check on.
string network = 2;
// The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the
// internal resource lives (ex: "default").
string network = 3;

// The GCP zone the uptime check should egress from. Only respected for
// internal uptime checks, where internal_network is specified.
string gcp_zone = 3;

// The checker ID.
string checker_id = 4;
string gcp_zone = 4;

// The checker's human-readable name.
string display_name = 5;
// The GCP project_id where the internal checker lives. Not necessary
// the same as the workspace project.
string peer_project_id = 6;
}

// This message configures which resources and services to monitor for
Expand Down Expand Up @@ -118,11 +129,10 @@ message UptimeCheckConfig {
int32 port = 1;
}

// Used to perform string matching. Currently, this matches on the exact
// content. In the future, it can be expanded to allow for regular expressions
// and more complex matching.
// Used to perform string matching. It allows substring and regular
// expressions, together with their negations.
message ContentMatcher {
// String content to match (max 1024 bytes)
// String or regex content to match (max 1024 bytes)
string content = 1;
}

Expand All @@ -137,7 +147,7 @@ message UptimeCheckConfig {
string name = 1;

// A human-friendly name for the uptime check configuration. The display name
// should be unique within a Stackdriver Account in order to make it easier
// should be unique within a Stackdriver Workspace in order to make it easier
// to identify; however, uniqueness is not enforced. Required.
string display_name = 2;

Expand Down Expand Up @@ -185,17 +195,21 @@ message UptimeCheckConfig {
repeated ContentMatcher content_matchers = 9;

// The list of regions from which the check will be run.
// Some regions contain one location, and others contain more than one.
// If this field is specified, enough regions to include a minimum of
// 3 locations must be provided, or an error message is returned.
// Not specifying this field will result in uptime checks running from all
// regions.
repeated UptimeCheckRegion selected_regions = 10;

// Denotes whether this is a check that egresses from InternalCheckers.
// If this is true, then checks are made only from the 'internal_checkers'.
// If it is false, then checks are made only from the 'selected_regions'.
// It is an error to provide 'selected_regions' when is_internal is true,
// or to provide 'internal_checkers' when is_internal is false.
bool is_internal = 15;

// The internal checkers that this check will egress from. If `is_internal` is
// true and this list is empty, the check will egress from all
// true and this list is empty, the check will egress from all the
// InternalCheckers configured for the project that owns this CheckConfig.
repeated InternalChecker internal_checkers = 14;
}
Expand Down
3 changes: 2 additions & 1 deletion protos/google/monitoring/v3/uptime_service.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC
// Copyright 2018 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -11,6 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

Expand Down
8 changes: 4 additions & 4 deletions src/v3/doc/google/monitoring/v3/doc_common.js
Original file line number Diff line number Diff line change
Expand Up @@ -509,8 +509,8 @@ const ComparisonType = {
};

/**
* The tier of service for a Stackdriver account. Please see the
* [service tiers documentation](https://cloud.google.com/monitoring/accounts/tiers)
* The tier of service for a Workspace. Please see the
* [service tiers documentation](https://cloud.google.com/monitoring/workspaces/tiers)
* for more details.
*
* @enum {number}
Expand All @@ -528,15 +528,15 @@ const ServiceTier = {
* The Stackdriver 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/accounts/tiers).
* 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 documentation](https://cloud.google.com/monitoring/accounts/tiers).
* more details, see [the service tiers documentation](https://cloud.google.com/monitoring/workspaces/tiers).
*/
SERVICE_TIER_PREMIUM: 2
};
Loading