@devvit/protos 0.11.19-next-2025-07-08-20-18-01-989363f22.0 → 0.11.19-next-2025-07-08-21-34-11-32558d0e0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/community.d.ts +1 -0
  2. package/community.d.ts.map +1 -1
  3. package/community.js +1 -0
  4. package/package.json +4 -4
  5. package/schema/.snootobuf/deps/google/api/annotations.proto +1 -1
  6. package/schema/.snootobuf/deps/google/api/auth.proto +19 -75
  7. package/schema/.snootobuf/deps/google/api/backend.proto +8 -142
  8. package/schema/.snootobuf/deps/google/api/billing.proto +13 -23
  9. package/schema/.snootobuf/deps/google/api/client.proto +1 -333
  10. package/schema/.snootobuf/deps/google/api/config_change.proto +3 -2
  11. package/schema/.snootobuf/deps/google/api/consumer.proto +2 -1
  12. package/schema/.snootobuf/deps/google/api/context.proto +5 -34
  13. package/schema/.snootobuf/deps/google/api/control.proto +7 -15
  14. package/schema/.snootobuf/deps/google/api/distribution.proto +5 -5
  15. package/schema/.snootobuf/deps/google/api/documentation.proto +16 -27
  16. package/schema/.snootobuf/deps/google/api/endpoint.proto +25 -23
  17. package/schema/.snootobuf/deps/google/api/field_behavior.proto +3 -23
  18. package/schema/.snootobuf/deps/google/api/http.proto +120 -173
  19. package/schema/.snootobuf/deps/google/api/httpbody.proto +6 -11
  20. package/schema/.snootobuf/deps/google/api/label.proto +2 -1
  21. package/schema/.snootobuf/deps/google/api/launch_stage.proto +5 -10
  22. package/schema/.snootobuf/deps/google/api/log.proto +2 -1
  23. package/schema/.snootobuf/deps/google/api/logging.proto +8 -6
  24. package/schema/.snootobuf/deps/google/api/metric.proto +40 -116
  25. package/schema/.snootobuf/deps/google/api/monitored_resource.proto +24 -38
  26. package/schema/.snootobuf/deps/google/api/monitoring.proto +25 -43
  27. package/schema/.snootobuf/deps/google/api/quota.proto +95 -20
  28. package/schema/.snootobuf/deps/google/api/resource.proto +74 -18
  29. package/schema/.snootobuf/deps/google/api/routing.proto +1 -1
  30. package/schema/.snootobuf/deps/google/api/service.proto +38 -54
  31. package/schema/.snootobuf/deps/google/api/source_info.proto +2 -1
  32. package/schema/.snootobuf/deps/google/api/system_parameter.proto +3 -3
  33. package/schema/.snootobuf/deps/google/api/usage.proto +5 -9
  34. package/schema/devvit/dev_portal/app/app.proto +5 -0
  35. package/schema/snootobuf.lock +589 -518
  36. package/schema/snootobuf.redditapi.lock +589 -518
  37. package/schema/snootobuf.ts.lock +589 -518
  38. package/types/devvit/dev_portal/admin_portal.d.ts +2 -2
  39. package/types/devvit/dev_portal/app/app.d.ts +6 -0
  40. package/types/devvit/dev_portal/app/app.d.ts.map +1 -1
  41. package/types/devvit/dev_portal/app/app.js +16 -0
  42. package/types/devvit/dev_portal/dev_portal.d.ts +42 -40
  43. package/types/devvit/dev_portal/dev_portal.d.ts.map +1 -1
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2019 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -11,6 +11,7 @@
11
11
  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
12
  // See the License for the specific language governing permissions and
13
13
  // limitations under the License.
14
+ //
14
15
 
15
16
  syntax = "proto3";
16
17
 
@@ -23,17 +24,11 @@ option java_package = "com.google.api";
23
24
  option objc_class_prefix = "GAPI";
24
25
 
25
26
  // The launch stage as defined by [Google Cloud Platform
26
- // Launch Stages](https://cloud.google.com/terms/launch-stages).
27
+ // Launch Stages](http://cloud.google.com/terms/launch-stages).
27
28
  enum LaunchStage {
28
29
  // Do not use this default value.
29
30
  LAUNCH_STAGE_UNSPECIFIED = 0;
30
31
 
31
- // The feature is not yet implemented. Users can not use it.
32
- UNIMPLEMENTED = 6;
33
-
34
- // Prelaunch features are hidden from users and are only visible internally.
35
- PRELAUNCH = 7;
36
-
37
32
  // Early Access features are limited to a closed group of testers. To use
38
33
  // these features, you must sign up in advance and sign a Trusted Tester
39
34
  // agreement (which includes confidentiality provisions). These features may
@@ -45,7 +40,7 @@ enum LaunchStage {
45
40
  // for widespread use. By Alpha, all significant design issues are resolved
46
41
  // and we are in the process of verifying functionality. Alpha customers
47
42
  // need to apply for access, agree to applicable terms, and have their
48
- // projects allowlisted. Alpha releases don't have to be feature complete,
43
+ // projects whitelisted. Alpha releases dont have to be feature complete,
49
44
  // no SLAs are provided, and there are no technical support obligations, but
50
45
  // they will be far enough along that customers can actually use them in
51
46
  // test environments or for limited-use tests -- just like they would in
@@ -64,7 +59,7 @@ enum LaunchStage {
64
59
  GA = 4;
65
60
 
66
61
  // Deprecated features are scheduled to be shut down and removed. For more
67
- // information, see the "Deprecation Policy" section of our [Terms of
62
+ // information, see the Deprecation Policy section of our [Terms of
68
63
  // Service](https://cloud.google.com/terms/)
69
64
  // and the [Google Cloud Platform Subject to the Deprecation
70
65
  // Policy](https://cloud.google.com/terms/deprecation) documentation.
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@ option java_outer_classname = "LogProto";
24
24
  option java_package = "com.google.api";
25
25
  option objc_class_prefix = "GAPI";
26
26
 
27
+
27
28
  // A description of a log type. Example in YAML format:
28
29
  //
29
30
  // - name: library.googleapis.com/activity_history
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -16,12 +16,15 @@ syntax = "proto3";
16
16
 
17
17
  package google.api;
18
18
 
19
+ import "google/api/annotations.proto";
20
+
19
21
  option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
20
22
  option java_multiple_files = true;
21
23
  option java_outer_classname = "LoggingProto";
22
24
  option java_package = "com.google.api";
23
25
  option objc_class_prefix = "GAPI";
24
26
 
27
+
25
28
  // Logging configuration of the service.
26
29
  //
27
30
  // The following example shows how to configure logs to be sent to the
@@ -56,14 +59,13 @@ message Logging {
56
59
  // or the consumer project).
57
60
  message LoggingDestination {
58
61
  // The monitored resource type. The type must be defined in the
59
- // [Service.monitored_resources][google.api.Service.monitored_resources]
60
- // section.
62
+ // [Service.monitored_resources][google.api.Service.monitored_resources] section.
61
63
  string monitored_resource = 3;
62
64
 
63
65
  // Names of the logs to be sent to this destination. Each name must
64
- // be defined in the [Service.logs][google.api.Service.logs] section. If the
65
- // log name is not a domain scoped name, it will be automatically prefixed
66
- // with the service name followed by "/".
66
+ // be defined in the [Service.logs][google.api.Service.logs] section. If the log name is
67
+ // not a domain scoped name, it will be automatically prefixed with
68
+ // the service name followed by "/".
67
69
  repeated string logs = 1;
68
70
  }
69
71
 
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -17,8 +17,6 @@ syntax = "proto3";
17
17
  package google.api;
18
18
 
19
19
  import "google/api/label.proto";
20
- import "google/api/launch_stage.proto";
21
- import "google/protobuf/duration.proto";
22
20
 
23
21
  option go_package = "google.golang.org/genproto/googleapis/api/metric;metric";
24
22
  option java_multiple_files = true;
@@ -26,14 +24,12 @@ option java_outer_classname = "MetricProto";
26
24
  option java_package = "com.google.api";
27
25
  option objc_class_prefix = "GAPI";
28
26
 
27
+
29
28
  // Defines a metric type and its schema. Once a metric descriptor is created,
30
29
  // deleting or altering it stops data collection and makes the metric type's
31
30
  // existing data unusable.
32
- //
33
31
  message MetricDescriptor {
34
32
  // The kind of measurement. It describes how the data is reported.
35
- // For information on setting the start time and end time based on
36
- // the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval].
37
33
  enum MetricKind {
38
34
  // Do not use this default value.
39
35
  METRIC_KIND_UNSPECIFIED = 0;
@@ -78,35 +74,15 @@ message MetricDescriptor {
78
74
  MONEY = 6;
79
75
  }
80
76
 
81
- // Additional annotations that can be used to guide the usage of a metric.
82
- message MetricDescriptorMetadata {
83
- // Deprecated. Must use the
84
- // [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage]
85
- // instead.
86
- LaunchStage launch_stage = 1 [deprecated = true];
87
-
88
- // The sampling period of metric data points. For metrics which are written
89
- // periodically, consecutive data points are stored at this time interval,
90
- // excluding data loss due to errors. Metrics with a higher granularity have
91
- // a smaller sampling period.
92
- google.protobuf.Duration sample_period = 2;
93
-
94
- // The delay of data points caused by ingestion. Data points older than this
95
- // age are guaranteed to be ingested and available to be read, excluding
96
- // data loss due to errors.
97
- google.protobuf.Duration ingest_delay = 3;
98
- }
99
-
100
77
  // The resource name of the metric descriptor.
101
78
  string name = 1;
102
79
 
103
80
  // The metric type, including its DNS name prefix. The type is not
104
- // URL-encoded. All user-defined metric types have the DNS name
105
- // `custom.googleapis.com` or `external.googleapis.com`. Metric types should
106
- // use a natural hierarchical grouping. For example:
81
+ // URL-encoded. All user-defined custom metric types have the DNS name
82
+ // `custom.googleapis.com`. Metric types should use a natural hierarchical
83
+ // grouping. For example:
107
84
  //
108
85
  // "custom.googleapis.com/invoice/paid/amount"
109
- // "external.googleapis.com/prometheus/up"
110
86
  // "appengine.googleapis.com/http/server/response_latencies"
111
87
  string type = 8;
112
88
 
@@ -126,28 +102,10 @@ message MetricDescriptor {
126
102
  // Some combinations of `metric_kind` and `value_type` might not be supported.
127
103
  ValueType value_type = 4;
128
104
 
129
- // The units in which the metric value is reported. It is only applicable
130
- // if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
131
- // defines the representation of the stored metric values.
132
- //
133
- // Different systems might scale the values to be more easily displayed (so a
134
- // value of `0.02kBy` _might_ be displayed as `20By`, and a value of
135
- // `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
136
- // `kBy`, then the value of the metric is always in thousands of bytes, no
137
- // matter how it might be displayed.
138
- //
139
- // If you want a custom metric to record the exact number of CPU-seconds used
140
- // by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
141
- // `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
142
- // CPU-seconds, then the value is written as `12005`.
143
- //
144
- // Alternatively, if you want a custom metric to record data in a more
145
- // granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
146
- // `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
147
- // or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
148
- //
149
- // The supported units are a subset of [The Unified Code for Units of
150
- // Measure](https://unitsofmeasure.org/ucum.html) standard:
105
+ // The unit in which the metric value is reported. It is only applicable
106
+ // if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
107
+ // supported units are a subset of [The Unified Code for Units of
108
+ // Measure](http://unitsofmeasure.org/ucum.html) standard:
151
109
  //
152
110
  // **Basic units (UNIT)**
153
111
  //
@@ -157,44 +115,36 @@ message MetricDescriptor {
157
115
  // * `min` minute
158
116
  // * `h` hour
159
117
  // * `d` day
160
- // * `1` dimensionless
161
118
  //
162
119
  // **Prefixes (PREFIX)**
163
120
  //
164
- // * `k` kilo (10^3)
165
- // * `M` mega (10^6)
166
- // * `G` giga (10^9)
167
- // * `T` tera (10^12)
168
- // * `P` peta (10^15)
169
- // * `E` exa (10^18)
170
- // * `Z` zetta (10^21)
171
- // * `Y` yotta (10^24)
172
- //
173
- // * `m` milli (10^-3)
174
- // * `u` micro (10^-6)
175
- // * `n` nano (10^-9)
176
- // * `p` pico (10^-12)
177
- // * `f` femto (10^-15)
178
- // * `a` atto (10^-18)
179
- // * `z` zepto (10^-21)
180
- // * `y` yocto (10^-24)
181
- //
182
- // * `Ki` kibi (2^10)
183
- // * `Mi` mebi (2^20)
184
- // * `Gi` gibi (2^30)
185
- // * `Ti` tebi (2^40)
186
- // * `Pi` pebi (2^50)
121
+ // * `k` kilo (10**3)
122
+ // * `M` mega (10**6)
123
+ // * `G` giga (10**9)
124
+ // * `T` tera (10**12)
125
+ // * `P` peta (10**15)
126
+ // * `E` exa (10**18)
127
+ // * `Z` zetta (10**21)
128
+ // * `Y` yotta (10**24)
129
+ // * `m` milli (10**-3)
130
+ // * `u` micro (10**-6)
131
+ // * `n` nano (10**-9)
132
+ // * `p` pico (10**-12)
133
+ // * `f` femto (10**-15)
134
+ // * `a` atto (10**-18)
135
+ // * `z` zepto (10**-21)
136
+ // * `y` yocto (10**-24)
137
+ // * `Ki` kibi (2**10)
138
+ // * `Mi` mebi (2**20)
139
+ // * `Gi` gibi (2**30)
140
+ // * `Ti` tebi (2**40)
187
141
  //
188
142
  // **Grammar**
189
143
  //
190
144
  // The grammar also includes these connectors:
191
145
  //
192
- // * `/` division or ratio (as an infix operator). For examples,
193
- // `kBy/{email}` or `MiBy/10ms` (although you should almost never
194
- // have `/s` in a metric `unit`; rates should always be computed at
195
- // query time from the underlying cumulative or delta value).
196
- // * `.` multiplication or composition (as an infix operator). For
197
- // examples, `GBy.d` or `k{watt}.h`.
146
+ // * `/` division (as an infix operator, e.g. `1/s`).
147
+ // * `.` multiplication (as an infix operator, e.g. `GBy.d`)
198
148
  //
199
149
  // The grammar for a unit is as follows:
200
150
  //
@@ -209,25 +159,14 @@ message MetricDescriptor {
209
159
  //
210
160
  // Notes:
211
161
  //
212
- // * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
213
- // is used alone, then the unit is equivalent to `1`. For examples,
214
- // `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
162
+ // * `Annotation` is just a comment if it follows a `UNIT` and is
163
+ // equivalent to `1` if it is used alone. For examples,
164
+ // `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
215
165
  // * `NAME` is a sequence of non-blank printable ASCII characters not
216
- // containing `{` or `}`.
217
- // * `1` represents a unitary [dimensionless
218
- // unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
219
- // as in `1/s`. It is typically used when none of the basic units are
220
- // appropriate. For example, "new users per day" can be represented as
221
- // `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
222
- // users). Alternatively, "thousands of page views per day" would be
223
- // represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
224
- // value of `5.3` would mean "5300 page views per day").
225
- // * `%` represents dimensionless value of 1/100, and annotates values giving
226
- // a percentage (so the metric values are typically in the range of 0..100,
227
- // and a metric value `3` means "3 percent").
228
- // * `10^2.%` indicates a metric contains a ratio, typically in the range
229
- // 0..1, that will be multiplied by 100 and displayed as a percentage
230
- // (so a metric value `0.03` means "3 percent").
166
+ // containing '{' or '}'.
167
+ // * `1` represents dimensionless value 1, such as in `1/s`.
168
+ // * `%` represents dimensionless value 1/100, and annotates values giving
169
+ // a percentage.
231
170
  string unit = 5;
232
171
 
233
172
  // A detailed description of the metric, which can be used in documentation.
@@ -238,28 +177,13 @@ message MetricDescriptor {
238
177
  // This field is optional but it is recommended to be set for any metrics
239
178
  // associated with user-visible concepts, such as Quota.
240
179
  string display_name = 7;
241
-
242
- // Optional. Metadata which can be used to guide usage of the metric.
243
- MetricDescriptorMetadata metadata = 10;
244
-
245
- // Optional. The launch stage of the metric definition.
246
- LaunchStage launch_stage = 12;
247
-
248
- // Read-only. If present, then a [time
249
- // series][google.monitoring.v3.TimeSeries], which is identified partially by
250
- // a metric type and a
251
- // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that
252
- // is associated with this metric type can only be associated with one of the
253
- // monitored resource types listed here.
254
- repeated string monitored_resource_types = 13;
255
180
  }
256
181
 
257
182
  // A specific metric, identified by specifying values for all of the
258
183
  // labels of a [`MetricDescriptor`][google.api.MetricDescriptor].
259
184
  message Metric {
260
- // An existing metric type, see
261
- // [google.api.MetricDescriptor][google.api.MetricDescriptor]. For example,
262
- // `custom.googleapis.com/invoice/paid/amount`.
185
+ // An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
186
+ // For example, `custom.googleapis.com/invoice/paid/amount`.
263
187
  string type = 3;
264
188
 
265
189
  // The set of label values that uniquely identify this metric. All
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@ syntax = "proto3";
17
17
  package google.api;
18
18
 
19
19
  import "google/api/label.proto";
20
- import "google/api/launch_stage.proto";
21
20
  import "google/protobuf/struct.proto";
22
21
 
23
22
  option cc_enable_arenas = true;
@@ -27,17 +26,16 @@ option java_outer_classname = "MonitoredResourceProto";
27
26
  option java_package = "com.google.api";
28
27
  option objc_class_prefix = "GAPI";
29
28
 
30
- // An object that describes the schema of a
31
- // [MonitoredResource][google.api.MonitoredResource] object using a type name
32
- // and a set of labels. For example, the monitored resource descriptor for
33
- // Google Compute Engine VM instances has a type of
29
+
30
+ // An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a
31
+ // type name and a set of labels. For example, the monitored resource
32
+ // descriptor for Google Compute Engine VM instances has a type of
34
33
  // `"gce_instance"` and specifies the use of the labels `"instance_id"` and
35
34
  // `"zone"` to identify particular VM instances.
36
35
  //
37
36
  // Different APIs can support different monitored resource types. APIs generally
38
37
  // provide a `list` method that returns the monitored resource descriptors used
39
38
  // by the API.
40
- //
41
39
  message MonitoredResourceDescriptor {
42
40
  // Optional. The resource name of the monitored resource descriptor:
43
41
  // `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
@@ -49,10 +47,7 @@ message MonitoredResourceDescriptor {
49
47
 
50
48
  // Required. The monitored resource type. For example, the type
51
49
  // `"cloudsql_database"` represents databases in Google Cloud SQL.
52
- // For a list of types, see [Monitored resource
53
- // types](https://cloud.google.com/monitoring/api/resources)
54
- // and [Logging resource
55
- // types](https://cloud.google.com/logging/docs/api/v2/resource-list).
50
+ // The maximum length of this value is 256 characters.
56
51
  string type = 1;
57
52
 
58
53
  // Optional. A concise name for the monitored resource type that might be
@@ -69,35 +64,25 @@ message MonitoredResourceDescriptor {
69
64
  // resource type. For example, an individual Google Cloud SQL database is
70
65
  // identified by values for the labels `"database_id"` and `"zone"`.
71
66
  repeated LabelDescriptor labels = 4;
72
-
73
- // Optional. The launch stage of the monitored resource definition.
74
- LaunchStage launch_stage = 7;
75
67
  }
76
68
 
77
69
  // An object representing a resource that can be used for monitoring, logging,
78
70
  // billing, or other purposes. Examples include virtual machine instances,
79
71
  // databases, and storage devices such as disks. The `type` field identifies a
80
- // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object
81
- // that describes the resource's schema. Information in the `labels` field
82
- // identifies the actual resource and its attributes according to the schema.
83
- // For example, a particular Compute Engine VM instance could be represented by
84
- // the following object, because the
85
- // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for
86
- // `"gce_instance"` has labels
87
- // `"project_id"`, `"instance_id"` and `"zone"`:
72
+ // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's
73
+ // schema. Information in the `labels` field identifies the actual resource and
74
+ // its attributes according to the schema. For example, a particular Compute
75
+ // Engine VM instance could be represented by the following object, because the
76
+ // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for `"gce_instance"` has labels
77
+ // `"instance_id"` and `"zone"`:
88
78
  //
89
79
  // { "type": "gce_instance",
90
- // "labels": { "project_id": "my-project",
91
- // "instance_id": "12345678901234",
80
+ // "labels": { "instance_id": "12345678901234",
92
81
  // "zone": "us-central1-a" }}
93
82
  message MonitoredResource {
94
83
  // Required. The monitored resource type. This field must match
95
- // the `type` field of a
96
- // [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor]
97
- // object. For example, the type of a Compute Engine VM instance is
98
- // `gce_instance`. Some descriptors include the service name in the type; for
99
- // example, the type of a Datastream stream is
100
- // `datastream.googleapis.com/Stream`.
84
+ // the `type` field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For
85
+ // example, the type of a Compute Engine VM instance is `gce_instance`.
101
86
  string type = 1;
102
87
 
103
88
  // Required. Values for all of the labels listed in the associated monitored
@@ -106,16 +91,17 @@ message MonitoredResource {
106
91
  map<string, string> labels = 2;
107
92
  }
108
93
 
109
- // Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource]
110
- // object. [MonitoredResource][google.api.MonitoredResource] objects contain the
111
- // minimum set of information to uniquely identify a monitored resource
112
- // instance. There is some other useful auxiliary metadata. Monitoring and
113
- // Logging use an ingestion pipeline to extract metadata for cloud resources of
114
- // all types, and store the metadata in this message.
94
+ // Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object.
95
+ // [MonitoredResource][google.api.MonitoredResource] objects contain the minimum set of information to
96
+ // uniquely identify a monitored resource instance. There is some other useful
97
+ // auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion
98
+ // pipeline to extract metadata for cloud resources of all types , and stores
99
+ // the metadata in this message.
115
100
  message MonitoredResourceMetadata {
116
101
  // Output only. Values for predefined system metadata labels.
117
- // System labels are a kind of metadata extracted by Google, including
118
- // "machine_image", "vpc", "subnet_id",
102
+ // System labels are a kind of metadata extracted by Google Stackdriver.
103
+ // Stackdriver determines what system labels are useful and how to obtain
104
+ // their values. Some examples: "machine_image", "vpc", "subnet_id",
119
105
  // "security_group", "name", etc.
120
106
  // System label values can be only strings, Boolean values, or a list of
121
107
  // strings. For example:
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -16,92 +16,74 @@ syntax = "proto3";
16
16
 
17
17
  package google.api;
18
18
 
19
+ import "google/api/annotations.proto";
20
+
19
21
  option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
20
22
  option java_multiple_files = true;
21
23
  option java_outer_classname = "MonitoringProto";
22
24
  option java_package = "com.google.api";
23
25
  option objc_class_prefix = "GAPI";
24
26
 
27
+
25
28
  // Monitoring configuration of the service.
26
29
  //
27
30
  // The example below shows how to configure monitored resources and metrics
28
31
  // for monitoring. In the example, a monitored resource and two metrics are
29
32
  // defined. The `library.googleapis.com/book/returned_count` metric is sent
30
33
  // to both producer and consumer projects, whereas the
31
- // `library.googleapis.com/book/num_overdue` metric is only sent to the
34
+ // `library.googleapis.com/book/overdue_count` metric is only sent to the
32
35
  // consumer project.
33
36
  //
34
37
  // monitored_resources:
35
- // - type: library.googleapis.com/Branch
36
- // display_name: "Library Branch"
37
- // description: "A branch of a library."
38
- // launch_stage: GA
38
+ // - type: library.googleapis.com/branch
39
39
  // labels:
40
- // - key: resource_container
41
- // description: "The Cloud container (ie. project id) for the Branch."
42
- // - key: location
43
- // description: "The location of the library branch."
44
- // - key: branch_id
45
- // description: "The id of the branch."
40
+ // - key: /city
41
+ // description: The city where the library branch is located in.
42
+ // - key: /name
43
+ // description: The name of the branch.
46
44
  // metrics:
47
45
  // - name: library.googleapis.com/book/returned_count
48
- // display_name: "Books Returned"
49
- // description: "The count of books that have been returned."
50
- // launch_stage: GA
51
46
  // metric_kind: DELTA
52
47
  // value_type: INT64
53
- // unit: "1"
54
48
  // labels:
55
- // - key: customer_id
56
- // description: "The id of the customer."
57
- // - name: library.googleapis.com/book/num_overdue
58
- // display_name: "Books Overdue"
59
- // description: "The current number of overdue books."
60
- // launch_stage: GA
49
+ // - key: /customer_id
50
+ // - name: library.googleapis.com/book/overdue_count
61
51
  // metric_kind: GAUGE
62
52
  // value_type: INT64
63
- // unit: "1"
64
53
  // labels:
65
- // - key: customer_id
66
- // description: "The id of the customer."
54
+ // - key: /customer_id
67
55
  // monitoring:
68
56
  // producer_destinations:
69
- // - monitored_resource: library.googleapis.com/Branch
57
+ // - monitored_resource: library.googleapis.com/branch
70
58
  // metrics:
71
59
  // - library.googleapis.com/book/returned_count
72
60
  // consumer_destinations:
73
- // - monitored_resource: library.googleapis.com/Branch
61
+ // - monitored_resource: library.googleapis.com/branch
74
62
  // metrics:
75
63
  // - library.googleapis.com/book/returned_count
76
- // - library.googleapis.com/book/num_overdue
64
+ // - library.googleapis.com/book/overdue_count
77
65
  message Monitoring {
78
66
  // Configuration of a specific monitoring destination (the producer project
79
67
  // or the consumer project).
80
68
  message MonitoringDestination {
81
69
  // The monitored resource type. The type must be defined in
82
- // [Service.monitored_resources][google.api.Service.monitored_resources]
83
- // section.
70
+ // [Service.monitored_resources][google.api.Service.monitored_resources] section.
84
71
  string monitored_resource = 1;
85
72
 
86
- // Types of the metrics to report to this monitoring destination.
87
- // Each type must be defined in
88
- // [Service.metrics][google.api.Service.metrics] section.
73
+ // Names of the metrics to report to this monitoring destination.
74
+ // Each name must be defined in [Service.metrics][google.api.Service.metrics] section.
89
75
  repeated string metrics = 2;
90
76
  }
91
77
 
92
78
  // Monitoring configurations for sending metrics to the producer project.
93
- // There can be multiple producer destinations. A monitored resource type may
94
- // appear in multiple monitoring destinations if different aggregations are
95
- // needed for different sets of metrics associated with that monitored
96
- // resource type. A monitored resource and metric pair may only be used once
97
- // in the Monitoring configuration.
79
+ // There can be multiple producer destinations, each one must have a
80
+ // different monitored resource type. A metric can be used in at most
81
+ // one producer destination.
98
82
  repeated MonitoringDestination producer_destinations = 1;
99
83
 
100
84
  // Monitoring configurations for sending metrics to the consumer project.
101
- // There can be multiple consumer destinations. A monitored resource type may
102
- // appear in multiple monitoring destinations if different aggregations are
103
- // needed for different sets of metrics associated with that monitored
104
- // resource type. A monitored resource and metric pair may only be used once
105
- // in the Monitoring configuration.
85
+ // There can be multiple consumer destinations, each one must have a
86
+ // different monitored resource type. A metric can be used in at most
87
+ // one consumer destination.
106
88
  repeated MonitoringDestination consumer_destinations = 2;
107
89
  }