google-cloud-bigquery-migration-v2 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.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_entities_pb.rb +89 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_error_details_pb.rb +39 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_metrics_pb.rb +52 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service/client.rb +1016 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service/credentials.rb +49 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service/paths.rb +92 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service.rb +51 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service_pb.rb +76 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service_services_pb.rb +62 -0
- data/lib/google/cloud/bigquery/migration/v2/translation_config_pb.rb +127 -0
- data/lib/google/cloud/bigquery/migration/v2/version.rb +30 -0
- data/lib/google/cloud/bigquery/migration/v2.rb +42 -0
- data/lib/google-cloud-bigquery-migration-v2.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/distribution.rb +225 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/label.rb +49 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/metric.rb +276 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_entities.rb +220 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_error_details.rb +72 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_metrics.rb +119 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_service.rb +166 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/translation_config.rb +275 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/error_details.rb +297 -0
- metadata +227 -0
@@ -0,0 +1,276 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
# Defines a metric type and its schema. Once a metric descriptor is created,
|
23
|
+
# deleting or altering it stops data collection and makes the metric type's
|
24
|
+
# existing data unusable.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# The resource name of the metric descriptor.
|
28
|
+
# @!attribute [rw] type
|
29
|
+
# @return [::String]
|
30
|
+
# The metric type, including its DNS name prefix. The type is not
|
31
|
+
# URL-encoded. All user-defined metric types have the DNS name
|
32
|
+
# `custom.googleapis.com` or `external.googleapis.com`. Metric types should
|
33
|
+
# use a natural hierarchical grouping. For example:
|
34
|
+
#
|
35
|
+
# "custom.googleapis.com/invoice/paid/amount"
|
36
|
+
# "external.googleapis.com/prometheus/up"
|
37
|
+
# "appengine.googleapis.com/http/server/response_latencies"
|
38
|
+
# @!attribute [rw] labels
|
39
|
+
# @return [::Array<::Google::Api::LabelDescriptor>]
|
40
|
+
# The set of labels that can be used to describe a specific
|
41
|
+
# instance of this metric type. For example, the
|
42
|
+
# `appengine.googleapis.com/http/server/response_latencies` metric
|
43
|
+
# type has a label for the HTTP response code, `response_code`, so
|
44
|
+
# you can look at latencies for successful responses or just
|
45
|
+
# for responses that failed.
|
46
|
+
# @!attribute [rw] metric_kind
|
47
|
+
# @return [::Google::Api::MetricDescriptor::MetricKind]
|
48
|
+
# Whether the metric records instantaneous values, changes to a value, etc.
|
49
|
+
# Some combinations of `metric_kind` and `value_type` might not be supported.
|
50
|
+
# @!attribute [rw] value_type
|
51
|
+
# @return [::Google::Api::MetricDescriptor::ValueType]
|
52
|
+
# Whether the measurement is an integer, a floating-point number, etc.
|
53
|
+
# Some combinations of `metric_kind` and `value_type` might not be supported.
|
54
|
+
# @!attribute [rw] unit
|
55
|
+
# @return [::String]
|
56
|
+
# The units in which the metric value is reported. It is only applicable
|
57
|
+
# if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
|
58
|
+
# defines the representation of the stored metric values.
|
59
|
+
#
|
60
|
+
# Different systems might scale the values to be more easily displayed (so a
|
61
|
+
# value of `0.02kBy` _might_ be displayed as `20By`, and a value of
|
62
|
+
# `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
|
63
|
+
# `kBy`, then the value of the metric is always in thousands of bytes, no
|
64
|
+
# matter how it might be displayed.
|
65
|
+
#
|
66
|
+
# If you want a custom metric to record the exact number of CPU-seconds used
|
67
|
+
# by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
|
68
|
+
# `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
|
69
|
+
# CPU-seconds, then the value is written as `12005`.
|
70
|
+
#
|
71
|
+
# Alternatively, if you want a custom metric to record data in a more
|
72
|
+
# granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
|
73
|
+
# `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
|
74
|
+
# or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
|
75
|
+
#
|
76
|
+
# The supported units are a subset of [The Unified Code for Units of
|
77
|
+
# Measure](https://unitsofmeasure.org/ucum.html) standard:
|
78
|
+
#
|
79
|
+
# **Basic units (UNIT)**
|
80
|
+
#
|
81
|
+
# * `bit` bit
|
82
|
+
# * `By` byte
|
83
|
+
# * `s` second
|
84
|
+
# * `min` minute
|
85
|
+
# * `h` hour
|
86
|
+
# * `d` day
|
87
|
+
# * `1` dimensionless
|
88
|
+
#
|
89
|
+
# **Prefixes (PREFIX)**
|
90
|
+
#
|
91
|
+
# * `k` kilo (10^3)
|
92
|
+
# * `M` mega (10^6)
|
93
|
+
# * `G` giga (10^9)
|
94
|
+
# * `T` tera (10^12)
|
95
|
+
# * `P` peta (10^15)
|
96
|
+
# * `E` exa (10^18)
|
97
|
+
# * `Z` zetta (10^21)
|
98
|
+
# * `Y` yotta (10^24)
|
99
|
+
#
|
100
|
+
# * `m` milli (10^-3)
|
101
|
+
# * `u` micro (10^-6)
|
102
|
+
# * `n` nano (10^-9)
|
103
|
+
# * `p` pico (10^-12)
|
104
|
+
# * `f` femto (10^-15)
|
105
|
+
# * `a` atto (10^-18)
|
106
|
+
# * `z` zepto (10^-21)
|
107
|
+
# * `y` yocto (10^-24)
|
108
|
+
#
|
109
|
+
# * `Ki` kibi (2^10)
|
110
|
+
# * `Mi` mebi (2^20)
|
111
|
+
# * `Gi` gibi (2^30)
|
112
|
+
# * `Ti` tebi (2^40)
|
113
|
+
# * `Pi` pebi (2^50)
|
114
|
+
#
|
115
|
+
# **Grammar**
|
116
|
+
#
|
117
|
+
# The grammar also includes these connectors:
|
118
|
+
#
|
119
|
+
# * `/` division or ratio (as an infix operator). For examples,
|
120
|
+
# `kBy/{email}` or `MiBy/10ms` (although you should almost never
|
121
|
+
# have `/s` in a metric `unit`; rates should always be computed at
|
122
|
+
# query time from the underlying cumulative or delta value).
|
123
|
+
# * `.` multiplication or composition (as an infix operator). For
|
124
|
+
# examples, `GBy.d` or `k{watt}.h`.
|
125
|
+
#
|
126
|
+
# The grammar for a unit is as follows:
|
127
|
+
#
|
128
|
+
# Expression = Component { "." Component } { "/" Component } ;
|
129
|
+
#
|
130
|
+
# Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
|
131
|
+
# | Annotation
|
132
|
+
# | "1"
|
133
|
+
# ;
|
134
|
+
#
|
135
|
+
# Annotation = "{" NAME "}" ;
|
136
|
+
#
|
137
|
+
# Notes:
|
138
|
+
#
|
139
|
+
# * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
|
140
|
+
# is used alone, then the unit is equivalent to `1`. For examples,
|
141
|
+
# `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
|
142
|
+
# * `NAME` is a sequence of non-blank printable ASCII characters not
|
143
|
+
# containing `{` or `}`.
|
144
|
+
# * `1` represents a unitary [dimensionless
|
145
|
+
# unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
|
146
|
+
# as in `1/s`. It is typically used when none of the basic units are
|
147
|
+
# appropriate. For example, "new users per day" can be represented as
|
148
|
+
# `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
|
149
|
+
# users). Alternatively, "thousands of page views per day" would be
|
150
|
+
# represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
|
151
|
+
# value of `5.3` would mean "5300 page views per day").
|
152
|
+
# * `%` represents dimensionless value of 1/100, and annotates values giving
|
153
|
+
# a percentage (so the metric values are typically in the range of 0..100,
|
154
|
+
# and a metric value `3` means "3 percent").
|
155
|
+
# * `10^2.%` indicates a metric contains a ratio, typically in the range
|
156
|
+
# 0..1, that will be multiplied by 100 and displayed as a percentage
|
157
|
+
# (so a metric value `0.03` means "3 percent").
|
158
|
+
# @!attribute [rw] description
|
159
|
+
# @return [::String]
|
160
|
+
# A detailed description of the metric, which can be used in documentation.
|
161
|
+
# @!attribute [rw] display_name
|
162
|
+
# @return [::String]
|
163
|
+
# A concise name for the metric, which can be displayed in user interfaces.
|
164
|
+
# Use sentence case without an ending period, for example "Request count".
|
165
|
+
# This field is optional but it is recommended to be set for any metrics
|
166
|
+
# associated with user-visible concepts, such as Quota.
|
167
|
+
# @!attribute [rw] metadata
|
168
|
+
# @return [::Google::Api::MetricDescriptor::MetricDescriptorMetadata]
|
169
|
+
# Optional. Metadata which can be used to guide usage of the metric.
|
170
|
+
# @!attribute [rw] launch_stage
|
171
|
+
# @return [::Google::Api::LaunchStage]
|
172
|
+
# Optional. The launch stage of the metric definition.
|
173
|
+
# @!attribute [rw] monitored_resource_types
|
174
|
+
# @return [::Array<::String>]
|
175
|
+
# Read-only. If present, then a [time
|
176
|
+
# series][google.monitoring.v3.TimeSeries], which is identified partially by
|
177
|
+
# a metric type and a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that is associated
|
178
|
+
# with this metric type can only be associated with one of the monitored
|
179
|
+
# resource types listed here.
|
180
|
+
class MetricDescriptor
|
181
|
+
include ::Google::Protobuf::MessageExts
|
182
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
183
|
+
|
184
|
+
# Additional annotations that can be used to guide the usage of a metric.
|
185
|
+
# @!attribute [rw] launch_stage
|
186
|
+
# @return [::Google::Api::LaunchStage]
|
187
|
+
# Deprecated. Must use the {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} instead.
|
188
|
+
# @!attribute [rw] sample_period
|
189
|
+
# @return [::Google::Protobuf::Duration]
|
190
|
+
# The sampling period of metric data points. For metrics which are written
|
191
|
+
# periodically, consecutive data points are stored at this time interval,
|
192
|
+
# excluding data loss due to errors. Metrics with a higher granularity have
|
193
|
+
# a smaller sampling period.
|
194
|
+
# @!attribute [rw] ingest_delay
|
195
|
+
# @return [::Google::Protobuf::Duration]
|
196
|
+
# The delay of data points caused by ingestion. Data points older than this
|
197
|
+
# age are guaranteed to be ingested and available to be read, excluding
|
198
|
+
# data loss due to errors.
|
199
|
+
class MetricDescriptorMetadata
|
200
|
+
include ::Google::Protobuf::MessageExts
|
201
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
202
|
+
end
|
203
|
+
|
204
|
+
# The kind of measurement. It describes how the data is reported.
|
205
|
+
# For information on setting the start time and end time based on
|
206
|
+
# the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval].
|
207
|
+
module MetricKind
|
208
|
+
# Do not use this default value.
|
209
|
+
METRIC_KIND_UNSPECIFIED = 0
|
210
|
+
|
211
|
+
# An instantaneous measurement of a value.
|
212
|
+
GAUGE = 1
|
213
|
+
|
214
|
+
# The change in a value during a time interval.
|
215
|
+
DELTA = 2
|
216
|
+
|
217
|
+
# A value accumulated over a time interval. Cumulative
|
218
|
+
# measurements in a time series should have the same start time
|
219
|
+
# and increasing end times, until an event resets the cumulative
|
220
|
+
# value to zero and sets a new start time for the following
|
221
|
+
# points.
|
222
|
+
CUMULATIVE = 3
|
223
|
+
end
|
224
|
+
|
225
|
+
# The value type of a metric.
|
226
|
+
module ValueType
|
227
|
+
# Do not use this default value.
|
228
|
+
VALUE_TYPE_UNSPECIFIED = 0
|
229
|
+
|
230
|
+
# The value is a boolean.
|
231
|
+
# This value type can be used only if the metric kind is `GAUGE`.
|
232
|
+
BOOL = 1
|
233
|
+
|
234
|
+
# The value is a signed 64-bit integer.
|
235
|
+
INT64 = 2
|
236
|
+
|
237
|
+
# The value is a double precision floating point number.
|
238
|
+
DOUBLE = 3
|
239
|
+
|
240
|
+
# The value is a text string.
|
241
|
+
# This value type can be used only if the metric kind is `GAUGE`.
|
242
|
+
STRING = 4
|
243
|
+
|
244
|
+
# The value is a {::Google::Api::Distribution `Distribution`}.
|
245
|
+
DISTRIBUTION = 5
|
246
|
+
|
247
|
+
# The value is money.
|
248
|
+
MONEY = 6
|
249
|
+
end
|
250
|
+
end
|
251
|
+
|
252
|
+
# A specific metric, identified by specifying values for all of the
|
253
|
+
# labels of a {::Google::Api::MetricDescriptor `MetricDescriptor`}.
|
254
|
+
# @!attribute [rw] type
|
255
|
+
# @return [::String]
|
256
|
+
# An existing metric type, see {::Google::Api::MetricDescriptor google.api.MetricDescriptor}.
|
257
|
+
# For example, `custom.googleapis.com/invoice/paid/amount`.
|
258
|
+
# @!attribute [rw] labels
|
259
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
260
|
+
# The set of label values that uniquely identify this metric. All
|
261
|
+
# labels listed in the `MetricDescriptor` must be assigned values.
|
262
|
+
class Metric
|
263
|
+
include ::Google::Protobuf::MessageExts
|
264
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
265
|
+
|
266
|
+
# @!attribute [rw] key
|
267
|
+
# @return [::String]
|
268
|
+
# @!attribute [rw] value
|
269
|
+
# @return [::String]
|
270
|
+
class LabelsEntry
|
271
|
+
include ::Google::Protobuf::MessageExts
|
272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
273
|
+
end
|
274
|
+
end
|
275
|
+
end
|
276
|
+
end
|
@@ -0,0 +1,222 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
# pattern: "projects/{project}/topics/{topic}"
|
37
|
+
# };
|
38
|
+
# }
|
39
|
+
#
|
40
|
+
# The ResourceDescriptor Yaml config will look like:
|
41
|
+
#
|
42
|
+
# resources:
|
43
|
+
# - type: "pubsub.googleapis.com/Topic"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
45
|
+
#
|
46
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
47
|
+
# live under multiple parents.
|
48
|
+
#
|
49
|
+
# Example:
|
50
|
+
#
|
51
|
+
# message LogEntry {
|
52
|
+
# option (google.api.resource) = {
|
53
|
+
# type: "logging.googleapis.com/LogEntry"
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
58
|
+
# };
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# The ResourceDescriptor Yaml config will look like:
|
62
|
+
#
|
63
|
+
# resources:
|
64
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
69
|
+
# @!attribute [rw] type
|
70
|
+
# @return [::String]
|
71
|
+
# The resource type. It must be in the format of
|
72
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
73
|
+
# singular and must not include version numbers.
|
74
|
+
#
|
75
|
+
# Example: `storage.googleapis.com/Bucket`
|
76
|
+
#
|
77
|
+
# The value of the resource_type_kind must follow the regular expression
|
78
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
79
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
80
|
+
# characters allowed for the `resource_type_kind` is 100.
|
81
|
+
# @!attribute [rw] pattern
|
82
|
+
# @return [::Array<::String>]
|
83
|
+
# Optional. The relative resource name pattern associated with this resource
|
84
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
85
|
+
#
|
86
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
87
|
+
# syntax:
|
88
|
+
#
|
89
|
+
# Template = Segment { "/" Segment } ;
|
90
|
+
# Segment = LITERAL | Variable ;
|
91
|
+
# Variable = "{" LITERAL "}" ;
|
92
|
+
#
|
93
|
+
# Examples:
|
94
|
+
#
|
95
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
96
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
97
|
+
#
|
98
|
+
# The components in braces correspond to the IDs for each resource in the
|
99
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
100
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
101
|
+
# type of resource.
|
102
|
+
# @!attribute [rw] name_field
|
103
|
+
# @return [::String]
|
104
|
+
# Optional. The field on the resource that designates the resource name
|
105
|
+
# field. If omitted, this is assumed to be "name".
|
106
|
+
# @!attribute [rw] history
|
107
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
108
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
109
|
+
#
|
110
|
+
# Example:
|
111
|
+
#
|
112
|
+
# // The InspectTemplate message originally only supported resource
|
113
|
+
# // names with organization, and project was added later.
|
114
|
+
# message InspectTemplate {
|
115
|
+
# option (google.api.resource) = {
|
116
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
117
|
+
# pattern:
|
118
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
119
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
120
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
121
|
+
# };
|
122
|
+
# }
|
123
|
+
# @!attribute [rw] plural
|
124
|
+
# @return [::String]
|
125
|
+
# The plural name used in the resource name and permission names, such as
|
126
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
128
|
+
# concept of the `plural` field in k8s CRD spec
|
129
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
130
|
+
#
|
131
|
+
# Note: The plural form is required even for singleton resources. See
|
132
|
+
# https://aip.dev/156
|
133
|
+
# @!attribute [rw] singular
|
134
|
+
# @return [::String]
|
135
|
+
# The same concept of the `singular` field in k8s CRD spec
|
136
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
137
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
138
|
+
# @!attribute [rw] style
|
139
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
140
|
+
# Style flag(s) for this resource.
|
141
|
+
# These indicate that a resource is expected to conform to a given
|
142
|
+
# style. See the specific style flags for additional information.
|
143
|
+
class ResourceDescriptor
|
144
|
+
include ::Google::Protobuf::MessageExts
|
145
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
146
|
+
|
147
|
+
# A description of the historical or future-looking state of the
|
148
|
+
# resource pattern.
|
149
|
+
module History
|
150
|
+
# The "unset" value.
|
151
|
+
HISTORY_UNSPECIFIED = 0
|
152
|
+
|
153
|
+
# The resource originally had one pattern and launched as such, and
|
154
|
+
# additional patterns were added later.
|
155
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
156
|
+
|
157
|
+
# The resource has one pattern, but the API owner expects to add more
|
158
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
159
|
+
# that from being necessary once there are multiple patterns.)
|
160
|
+
FUTURE_MULTI_PATTERN = 2
|
161
|
+
end
|
162
|
+
|
163
|
+
# A flag representing a specific style that a resource claims to conform to.
|
164
|
+
module Style
|
165
|
+
# The unspecified value. Do not use.
|
166
|
+
STYLE_UNSPECIFIED = 0
|
167
|
+
|
168
|
+
# This resource is intended to be "declarative-friendly".
|
169
|
+
#
|
170
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
171
|
+
# setting this to true communicates to tools that this resource should
|
172
|
+
# adhere to declarative-friendly expectations.
|
173
|
+
#
|
174
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
175
|
+
# additional checks.
|
176
|
+
DECLARATIVE_FRIENDLY = 1
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# Defines a proto annotation that describes a string field that refers to
|
181
|
+
# an API resource.
|
182
|
+
# @!attribute [rw] type
|
183
|
+
# @return [::String]
|
184
|
+
# The resource type that the annotated field references.
|
185
|
+
#
|
186
|
+
# Example:
|
187
|
+
#
|
188
|
+
# message Subscription {
|
189
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
190
|
+
# type: "pubsub.googleapis.com/Topic"
|
191
|
+
# }];
|
192
|
+
# }
|
193
|
+
#
|
194
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
195
|
+
# APIs use the special value * in their resource reference.
|
196
|
+
#
|
197
|
+
# Example:
|
198
|
+
#
|
199
|
+
# message GetIamPolicyRequest {
|
200
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
201
|
+
# type: "*"
|
202
|
+
# }];
|
203
|
+
# }
|
204
|
+
# @!attribute [rw] child_type
|
205
|
+
# @return [::String]
|
206
|
+
# The resource type of a child collection that the annotated field
|
207
|
+
# references. This is useful for annotating the `parent` field that
|
208
|
+
# doesn't have a fixed resource type.
|
209
|
+
#
|
210
|
+
# Example:
|
211
|
+
#
|
212
|
+
# message ListLogEntriesRequest {
|
213
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
214
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
215
|
+
# };
|
216
|
+
# }
|
217
|
+
class ResourceReference
|
218
|
+
include ::Google::Protobuf::MessageExts
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|