google-cloud-monitoring-dashboard-v1 0.1.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 (39) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +71 -0
  6. data/lib/google-cloud-monitoring-dashboard-v1.rb +21 -0
  7. data/lib/google/cloud/monitoring/dashboard/v1.rb +37 -0
  8. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service.rb +51 -0
  9. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb +699 -0
  10. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/credentials.rb +56 -0
  11. data/lib/google/cloud/monitoring/dashboard/v1/version.rb +30 -0
  12. data/lib/google/monitoring/dashboard/v1/common_pb.rb +98 -0
  13. data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb +32 -0
  14. data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb +54 -0
  15. data/lib/google/monitoring/dashboard/v1/dashboards_service_services_pb.rb +77 -0
  16. data/lib/google/monitoring/dashboard/v1/drilldowns_pb.rb +20 -0
  17. data/lib/google/monitoring/dashboard/v1/layouts_pb.rb +44 -0
  18. data/lib/google/monitoring/dashboard/v1/metrics_pb.rb +79 -0
  19. data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb +41 -0
  20. data/lib/google/monitoring/dashboard/v1/service_pb.rb +20 -0
  21. data/lib/google/monitoring/dashboard/v1/text_pb.rb +31 -0
  22. data/lib/google/monitoring/dashboard/v1/widget_pb.rb +35 -0
  23. data/lib/google/monitoring/dashboard/v1/xychart_pb.rb +69 -0
  24. data/proto_docs/README.md +4 -0
  25. data/proto_docs/google/api/field_behavior.rb +59 -0
  26. data/proto_docs/google/api/resource.rb +247 -0
  27. data/proto_docs/google/monitoring/dashboard/v1/common.rb +409 -0
  28. data/proto_docs/google/monitoring/dashboard/v1/dashboard.rb +62 -0
  29. data/proto_docs/google/monitoring/dashboard/v1/dashboards_service.rb +106 -0
  30. data/proto_docs/google/monitoring/dashboard/v1/layouts.rb +92 -0
  31. data/proto_docs/google/monitoring/dashboard/v1/metrics.rb +172 -0
  32. data/proto_docs/google/monitoring/dashboard/v1/scorecard.rb +117 -0
  33. data/proto_docs/google/monitoring/dashboard/v1/text.rb +52 -0
  34. data/proto_docs/google/monitoring/dashboard/v1/widget.rb +50 -0
  35. data/proto_docs/google/monitoring/dashboard/v1/xychart.rb +159 -0
  36. data/proto_docs/google/protobuf/duration.rb +98 -0
  37. data/proto_docs/google/protobuf/empty.rb +36 -0
  38. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  39. metadata +221 -0
@@ -0,0 +1,41 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/monitoring/dashboard/v1/scorecard.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/monitoring/dashboard/v1/metrics_pb'
7
+ require 'google/protobuf/duration_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/monitoring/dashboard/v1/scorecard.proto", :syntax => :proto3) do
10
+ add_message "google.monitoring.dashboard.v1.Scorecard" do
11
+ optional :time_series_query, :message, 1, "google.monitoring.dashboard.v1.TimeSeriesQuery"
12
+ repeated :thresholds, :message, 6, "google.monitoring.dashboard.v1.Threshold"
13
+ oneof :data_view do
14
+ optional :gauge_view, :message, 4, "google.monitoring.dashboard.v1.Scorecard.GaugeView"
15
+ optional :spark_chart_view, :message, 5, "google.monitoring.dashboard.v1.Scorecard.SparkChartView"
16
+ end
17
+ end
18
+ add_message "google.monitoring.dashboard.v1.Scorecard.GaugeView" do
19
+ optional :lower_bound, :double, 1
20
+ optional :upper_bound, :double, 2
21
+ end
22
+ add_message "google.monitoring.dashboard.v1.Scorecard.SparkChartView" do
23
+ optional :spark_chart_type, :enum, 1, "google.monitoring.dashboard.v1.SparkChartType"
24
+ optional :min_alignment_period, :message, 2, "google.protobuf.Duration"
25
+ end
26
+ end
27
+ end
28
+
29
+ module Google
30
+ module Cloud
31
+ module Monitoring
32
+ module Dashboard
33
+ module V1
34
+ Scorecard = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.Scorecard").msgclass
35
+ Scorecard::GaugeView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.Scorecard.GaugeView").msgclass
36
+ Scorecard::SparkChartView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.Scorecard.SparkChartView").msgclass
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,20 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/monitoring/dashboard/v1/service.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ Google::Protobuf::DescriptorPool.generated_pool.build do
7
+ add_file("google/monitoring/dashboard/v1/service.proto", :syntax => :proto3) do
8
+ end
9
+ end
10
+
11
+ module Google
12
+ module Cloud
13
+ module Monitoring
14
+ module Dashboard
15
+ module V1
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,31 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/monitoring/dashboard/v1/text.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ Google::Protobuf::DescriptorPool.generated_pool.build do
7
+ add_file("google/monitoring/dashboard/v1/text.proto", :syntax => :proto3) do
8
+ add_message "google.monitoring.dashboard.v1.Text" do
9
+ optional :content, :string, 1
10
+ optional :format, :enum, 2, "google.monitoring.dashboard.v1.Text.Format"
11
+ end
12
+ add_enum "google.monitoring.dashboard.v1.Text.Format" do
13
+ value :FORMAT_UNSPECIFIED, 0
14
+ value :MARKDOWN, 1
15
+ value :RAW, 2
16
+ end
17
+ end
18
+ end
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module Dashboard
24
+ module V1
25
+ Text = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.Text").msgclass
26
+ Text::Format = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.Text.Format").enummodule
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,35 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/monitoring/dashboard/v1/widget.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/monitoring/dashboard/v1/scorecard_pb'
8
+ require 'google/monitoring/dashboard/v1/text_pb'
9
+ require 'google/monitoring/dashboard/v1/xychart_pb'
10
+ require 'google/protobuf/empty_pb'
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/monitoring/dashboard/v1/widget.proto", :syntax => :proto3) do
13
+ add_message "google.monitoring.dashboard.v1.Widget" do
14
+ optional :title, :string, 1
15
+ oneof :content do
16
+ optional :xy_chart, :message, 2, "google.monitoring.dashboard.v1.XyChart"
17
+ optional :scorecard, :message, 3, "google.monitoring.dashboard.v1.Scorecard"
18
+ optional :text, :message, 4, "google.monitoring.dashboard.v1.Text"
19
+ optional :blank, :message, 5, "google.protobuf.Empty"
20
+ end
21
+ end
22
+ end
23
+ end
24
+
25
+ module Google
26
+ module Cloud
27
+ module Monitoring
28
+ module Dashboard
29
+ module V1
30
+ Widget = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.Widget").msgclass
31
+ end
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,69 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/monitoring/dashboard/v1/xychart.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/monitoring/dashboard/v1/metrics_pb'
8
+ require 'google/protobuf/duration_pb'
9
+ Google::Protobuf::DescriptorPool.generated_pool.build do
10
+ add_file("google/monitoring/dashboard/v1/xychart.proto", :syntax => :proto3) do
11
+ add_message "google.monitoring.dashboard.v1.XyChart" do
12
+ repeated :data_sets, :message, 1, "google.monitoring.dashboard.v1.XyChart.DataSet"
13
+ optional :timeshift_duration, :message, 4, "google.protobuf.Duration"
14
+ repeated :thresholds, :message, 5, "google.monitoring.dashboard.v1.Threshold"
15
+ optional :x_axis, :message, 6, "google.monitoring.dashboard.v1.XyChart.Axis"
16
+ optional :y_axis, :message, 7, "google.monitoring.dashboard.v1.XyChart.Axis"
17
+ optional :chart_options, :message, 8, "google.monitoring.dashboard.v1.ChartOptions"
18
+ end
19
+ add_message "google.monitoring.dashboard.v1.XyChart.DataSet" do
20
+ optional :time_series_query, :message, 1, "google.monitoring.dashboard.v1.TimeSeriesQuery"
21
+ optional :plot_type, :enum, 2, "google.monitoring.dashboard.v1.XyChart.DataSet.PlotType"
22
+ optional :legend_template, :string, 3
23
+ optional :min_alignment_period, :message, 4, "google.protobuf.Duration"
24
+ end
25
+ add_enum "google.monitoring.dashboard.v1.XyChart.DataSet.PlotType" do
26
+ value :PLOT_TYPE_UNSPECIFIED, 0
27
+ value :LINE, 1
28
+ value :STACKED_AREA, 2
29
+ value :STACKED_BAR, 3
30
+ value :HEATMAP, 4
31
+ end
32
+ add_message "google.monitoring.dashboard.v1.XyChart.Axis" do
33
+ optional :label, :string, 1
34
+ optional :scale, :enum, 2, "google.monitoring.dashboard.v1.XyChart.Axis.Scale"
35
+ end
36
+ add_enum "google.monitoring.dashboard.v1.XyChart.Axis.Scale" do
37
+ value :SCALE_UNSPECIFIED, 0
38
+ value :LINEAR, 1
39
+ value :LOG10, 2
40
+ end
41
+ add_message "google.monitoring.dashboard.v1.ChartOptions" do
42
+ optional :mode, :enum, 1, "google.monitoring.dashboard.v1.ChartOptions.Mode"
43
+ end
44
+ add_enum "google.monitoring.dashboard.v1.ChartOptions.Mode" do
45
+ value :MODE_UNSPECIFIED, 0
46
+ value :COLOR, 1
47
+ value :X_RAY, 2
48
+ value :STATS, 3
49
+ end
50
+ end
51
+ end
52
+
53
+ module Google
54
+ module Cloud
55
+ module Monitoring
56
+ module Dashboard
57
+ module V1
58
+ XyChart = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.XyChart").msgclass
59
+ XyChart::DataSet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.XyChart.DataSet").msgclass
60
+ XyChart::DataSet::PlotType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.XyChart.DataSet.PlotType").enummodule
61
+ XyChart::Axis = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.XyChart.Axis").msgclass
62
+ XyChart::Axis::Scale = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.XyChart.Axis.Scale").enummodule
63
+ ChartOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.ChartOptions").msgclass
64
+ ChartOptions::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.ChartOptions.Mode").enummodule
65
+ end
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,4 @@
1
+ # Cloud Monitoring Dashboards V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,59 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,247 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # name_descriptor: {
37
+ # pattern: "projects/{project}/topics/{topic}"
38
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
+ # parent_name_extractor: "projects/{project}"
40
+ # }
41
+ # };
42
+ # }
43
+ #
44
+ # The ResourceDescriptor Yaml config will look like:
45
+ #
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/\\{project}/topics/\\{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/\\{project}"
52
+ #
53
+ # Sometimes, resources have multiple patterns, typically because they can
54
+ # live under multiple parents.
55
+ #
56
+ # Example:
57
+ #
58
+ # message LogEntry {
59
+ # option (google.api.resource) = {
60
+ # type: "logging.googleapis.com/LogEntry"
61
+ # name_descriptor: {
62
+ # pattern: "projects/{project}/logs/{log}"
63
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
+ # parent_name_extractor: "projects/{project}"
65
+ # }
66
+ # name_descriptor: {
67
+ # pattern: "folders/{folder}/logs/{log}"
68
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
+ # parent_name_extractor: "folders/{folder}"
70
+ # }
71
+ # name_descriptor: {
72
+ # pattern: "organizations/{organization}/logs/{log}"
73
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
+ # parent_name_extractor: "organizations/{organization}"
75
+ # }
76
+ # name_descriptor: {
77
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
+ # parent_type: "billing.googleapis.com/BillingAccount"
79
+ # parent_name_extractor: "billingAccounts/{billing_account}"
80
+ # }
81
+ # };
82
+ # }
83
+ #
84
+ # The ResourceDescriptor Yaml config will look like:
85
+ #
86
+ # resources:
87
+ # - type: 'logging.googleapis.com/LogEntry'
88
+ # name_descriptor:
89
+ # - pattern: "projects/{project}/logs/{log}"
90
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
+ # parent_name_extractor: "projects/{project}"
92
+ # - pattern: "folders/{folder}/logs/{log}"
93
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
+ # parent_name_extractor: "folders/{folder}"
95
+ # - pattern: "organizations/{organization}/logs/{log}"
96
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
+ # parent_name_extractor: "organizations/{organization}"
98
+ # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
+ # parent_type: "billing.googleapis.com/BillingAccount"
100
+ # parent_name_extractor: "billingAccounts/{billing_account}"
101
+ #
102
+ # For flexible resources, the resource name doesn't contain parent names, but
103
+ # the resource itself has parents for policy evaluation.
104
+ #
105
+ # Example:
106
+ #
107
+ # message Shelf {
108
+ # option (google.api.resource) = {
109
+ # type: "library.googleapis.com/Shelf"
110
+ # name_descriptor: {
111
+ # pattern: "shelves/{shelf}"
112
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
+ # }
114
+ # name_descriptor: {
115
+ # pattern: "shelves/{shelf}"
116
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
+ # }
118
+ # };
119
+ # }
120
+ #
121
+ # The ResourceDescriptor Yaml config will look like:
122
+ #
123
+ # resources:
124
+ # - type: 'library.googleapis.com/Shelf'
125
+ # name_descriptor:
126
+ # - pattern: "shelves/{shelf}"
127
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
+ # - pattern: "shelves/{shelf}"
129
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
+ # @!attribute [rw] type
131
+ # @return [::String]
132
+ # The resource type. It must be in the format of
133
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
+ # singular and must not include version numbers.
135
+ #
136
+ # Example: `storage.googleapis.com/Bucket`
137
+ #
138
+ # The value of the resource_type_kind must follow the regular expression
139
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
140
+ # should use PascalCase (UpperCamelCase). The maximum number of
141
+ # characters allowed for the `resource_type_kind` is 100.
142
+ # @!attribute [rw] pattern
143
+ # @return [::Array<::String>]
144
+ # Optional. The relative resource name pattern associated with this resource
145
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
146
+ #
147
+ # The path pattern must follow the syntax, which aligns with HTTP binding
148
+ # syntax:
149
+ #
150
+ # Template = Segment { "/" Segment } ;
151
+ # Segment = LITERAL | Variable ;
152
+ # Variable = "{" LITERAL "}" ;
153
+ #
154
+ # Examples:
155
+ #
156
+ # - "projects/\\{project}/topics/\\{topic}"
157
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
158
+ #
159
+ # The components in braces correspond to the IDs for each resource in the
160
+ # hierarchy. It is expected that, if multiple patterns are provided,
161
+ # the same component name (e.g. "project") refers to IDs of the same
162
+ # type of resource.
163
+ # @!attribute [rw] name_field
164
+ # @return [::String]
165
+ # Optional. The field on the resource that designates the resource name
166
+ # field. If omitted, this is assumed to be "name".
167
+ # @!attribute [rw] history
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
+ # Optional. The historical or future-looking state of the resource pattern.
170
+ #
171
+ # Example:
172
+ #
173
+ # // The InspectTemplate message originally only supported resource
174
+ # // names with organization, and project was added later.
175
+ # message InspectTemplate {
176
+ # option (google.api.resource) = {
177
+ # type: "dlp.googleapis.com/InspectTemplate"
178
+ # pattern:
179
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
180
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
181
+ # history: ORIGINALLY_SINGLE_PATTERN
182
+ # };
183
+ # }
184
+ # @!attribute [rw] plural
185
+ # @return [::String]
186
+ # The plural name used in the resource name, such as 'projects' for
187
+ # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
+ # field in k8s CRD spec
189
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190
+ # @!attribute [rw] singular
191
+ # @return [::String]
192
+ # The same concept of the `singular` field in k8s CRD spec
193
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195
+ class ResourceDescriptor
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
+
199
+ # A description of the historical or future-looking state of the
200
+ # resource pattern.
201
+ module History
202
+ # The "unset" value.
203
+ HISTORY_UNSPECIFIED = 0
204
+
205
+ # The resource originally had one pattern and launched as such, and
206
+ # additional patterns were added later.
207
+ ORIGINALLY_SINGLE_PATTERN = 1
208
+
209
+ # The resource has one pattern, but the API owner expects to add more
210
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
211
+ # that from being necessary once there are multiple patterns.)
212
+ FUTURE_MULTI_PATTERN = 2
213
+ end
214
+ end
215
+
216
+ # Defines a proto annotation that describes a string field that refers to
217
+ # an API resource.
218
+ # @!attribute [rw] type
219
+ # @return [::String]
220
+ # The resource type that the annotated field references.
221
+ #
222
+ # Example:
223
+ #
224
+ # message Subscription {
225
+ # string topic = 2 [(google.api.resource_reference) = {
226
+ # type: "pubsub.googleapis.com/Topic"
227
+ # }];
228
+ # }
229
+ # @!attribute [rw] child_type
230
+ # @return [::String]
231
+ # The resource type of a child collection that the annotated field
232
+ # references. This is useful for annotating the `parent` field that
233
+ # doesn't have a fixed resource type.
234
+ #
235
+ # Example:
236
+ #
237
+ # message ListLogEntriesRequest {
238
+ # string parent = 1 [(google.api.resource_reference) = {
239
+ # child_type: "logging.googleapis.com/LogEntry"
240
+ # };
241
+ # }
242
+ class ResourceReference
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
+ end
246
+ end
247
+ end