google-cloud-service_usage-v1 0.2.0 → 0.3.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 +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +3 -3
- data/lib/google/api/serviceusage/v1/resources_pb.rb +32 -28
- data/lib/google/api/serviceusage/v1/serviceusage_pb.rb +25 -52
- data/lib/google/cloud/service_usage/v1/service_usage/client.rb +18 -20
- data/lib/google/cloud/service_usage/v1/service_usage/operations.rb +14 -24
- data/lib/google/cloud/service_usage/v1/service_usage.rb +1 -1
- data/lib/google/cloud/service_usage/v1/version.rb +1 -1
- data/lib/google/cloud/service_usage/v1.rb +2 -2
- data/proto_docs/google/api/auth.rb +10 -5
- data/proto_docs/google/api/client.rb +381 -0
- data/proto_docs/google/api/documentation.rb +16 -10
- data/proto_docs/google/api/endpoint.rb +14 -9
- data/proto_docs/google/api/launch_stage.rb +3 -3
- data/proto_docs/google/api/monitored_resource.rb +30 -18
- data/proto_docs/google/api/monitoring.rb +4 -2
- data/proto_docs/google/api/quota.rb +8 -7
- data/proto_docs/google/api/usage.rb +2 -1
- data/proto_docs/google/protobuf/any.rb +7 -4
- data/proto_docs/google/protobuf/api.rb +1 -1
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/protobuf/struct.rb +1 -1
- data/proto_docs/google/protobuf/type.rb +9 -0
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +11 -8
@@ -0,0 +1,381 @@
|
|
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
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to. This is the full protobuf
|
39
|
+
# package for the API, ending in the version element.
|
40
|
+
# Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
41
|
+
# @!attribute [rw] launch_stage
|
42
|
+
# @return [::Google::Api::LaunchStage]
|
43
|
+
# Launch stage of this version of the API.
|
44
|
+
# @!attribute [rw] rest_numeric_enums
|
45
|
+
# @return [::Boolean]
|
46
|
+
# When using transport=rest, the client request will encode enums as
|
47
|
+
# numbers rather than strings.
|
48
|
+
# @!attribute [rw] java_settings
|
49
|
+
# @return [::Google::Api::JavaSettings]
|
50
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
51
|
+
# @!attribute [rw] cpp_settings
|
52
|
+
# @return [::Google::Api::CppSettings]
|
53
|
+
# Settings for C++ client libraries.
|
54
|
+
# @!attribute [rw] php_settings
|
55
|
+
# @return [::Google::Api::PhpSettings]
|
56
|
+
# Settings for PHP client libraries.
|
57
|
+
# @!attribute [rw] python_settings
|
58
|
+
# @return [::Google::Api::PythonSettings]
|
59
|
+
# Settings for Python client libraries.
|
60
|
+
# @!attribute [rw] node_settings
|
61
|
+
# @return [::Google::Api::NodeSettings]
|
62
|
+
# Settings for Node client libraries.
|
63
|
+
# @!attribute [rw] dotnet_settings
|
64
|
+
# @return [::Google::Api::DotnetSettings]
|
65
|
+
# Settings for .NET client libraries.
|
66
|
+
# @!attribute [rw] ruby_settings
|
67
|
+
# @return [::Google::Api::RubySettings]
|
68
|
+
# Settings for Ruby client libraries.
|
69
|
+
# @!attribute [rw] go_settings
|
70
|
+
# @return [::Google::Api::GoSettings]
|
71
|
+
# Settings for Go client libraries.
|
72
|
+
class ClientLibrarySettings
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# This message configures the settings for publishing [Google Cloud Client
|
78
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
79
|
+
# generated from the service config.
|
80
|
+
# @!attribute [rw] method_settings
|
81
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
82
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
83
|
+
# long-running operation pattern.
|
84
|
+
# @!attribute [rw] new_issue_uri
|
85
|
+
# @return [::String]
|
86
|
+
# Link to a *public* URI where users can report issues. Example:
|
87
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
88
|
+
# @!attribute [rw] documentation_uri
|
89
|
+
# @return [::String]
|
90
|
+
# Link to product home page. Example:
|
91
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
92
|
+
# @!attribute [rw] api_short_name
|
93
|
+
# @return [::String]
|
94
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
95
|
+
# relations artifacts like docs, packages delivered to package managers,
|
96
|
+
# etc. Example: "speech".
|
97
|
+
# @!attribute [rw] github_label
|
98
|
+
# @return [::String]
|
99
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
100
|
+
# @!attribute [rw] codeowner_github_teams
|
101
|
+
# @return [::Array<::String>]
|
102
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
103
|
+
# containing source code for the client libraries for this API.
|
104
|
+
# @!attribute [rw] doc_tag_prefix
|
105
|
+
# @return [::String]
|
106
|
+
# A prefix used in sample code when demarking regions to be included in
|
107
|
+
# documentation.
|
108
|
+
# @!attribute [rw] organization
|
109
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
110
|
+
# For whom the client library is being published.
|
111
|
+
# @!attribute [rw] library_settings
|
112
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
113
|
+
# Client library settings. If the same version string appears multiple
|
114
|
+
# times in this list, then the last one wins. Settings from earlier
|
115
|
+
# settings with the same version string are discarded.
|
116
|
+
# @!attribute [rw] proto_reference_documentation_uri
|
117
|
+
# @return [::String]
|
118
|
+
# Optional link to proto reference documentation. Example:
|
119
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
120
|
+
class Publishing
|
121
|
+
include ::Google::Protobuf::MessageExts
|
122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
123
|
+
end
|
124
|
+
|
125
|
+
# Settings for Java client libraries.
|
126
|
+
# @!attribute [rw] library_package
|
127
|
+
# @return [::String]
|
128
|
+
# The package name to use in Java. Clobbers the java_package option
|
129
|
+
# set in the protobuf. This should be used **only** by APIs
|
130
|
+
# who have already set the language_settings.java.package_name" field
|
131
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
132
|
+
# where possible.
|
133
|
+
#
|
134
|
+
# Example of a YAML configuration::
|
135
|
+
#
|
136
|
+
# publishing:
|
137
|
+
# java_settings:
|
138
|
+
# library_package: com.google.cloud.pubsub.v1
|
139
|
+
# @!attribute [rw] service_class_names
|
140
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
141
|
+
# Configure the Java class name to use instead of the service's for its
|
142
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
143
|
+
# service names as they appear in the protobuf (including the full
|
144
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
145
|
+
# teams should otherwise use the service name as it appears in the
|
146
|
+
# protobuf.
|
147
|
+
#
|
148
|
+
# Example of a YAML configuration::
|
149
|
+
#
|
150
|
+
# publishing:
|
151
|
+
# java_settings:
|
152
|
+
# service_class_names:
|
153
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
154
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
155
|
+
# @!attribute [rw] common
|
156
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
157
|
+
# Some settings.
|
158
|
+
class JavaSettings
|
159
|
+
include ::Google::Protobuf::MessageExts
|
160
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
161
|
+
|
162
|
+
# @!attribute [rw] key
|
163
|
+
# @return [::String]
|
164
|
+
# @!attribute [rw] value
|
165
|
+
# @return [::String]
|
166
|
+
class ServiceClassNamesEntry
|
167
|
+
include ::Google::Protobuf::MessageExts
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# Settings for C++ client libraries.
|
173
|
+
# @!attribute [rw] common
|
174
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
175
|
+
# Some settings.
|
176
|
+
class CppSettings
|
177
|
+
include ::Google::Protobuf::MessageExts
|
178
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
179
|
+
end
|
180
|
+
|
181
|
+
# Settings for Php client libraries.
|
182
|
+
# @!attribute [rw] common
|
183
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
184
|
+
# Some settings.
|
185
|
+
class PhpSettings
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
|
190
|
+
# Settings for Python client libraries.
|
191
|
+
# @!attribute [rw] common
|
192
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
193
|
+
# Some settings.
|
194
|
+
class PythonSettings
|
195
|
+
include ::Google::Protobuf::MessageExts
|
196
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
197
|
+
end
|
198
|
+
|
199
|
+
# Settings for Node client libraries.
|
200
|
+
# @!attribute [rw] common
|
201
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
202
|
+
# Some settings.
|
203
|
+
class NodeSettings
|
204
|
+
include ::Google::Protobuf::MessageExts
|
205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
|
+
end
|
207
|
+
|
208
|
+
# Settings for Dotnet client libraries.
|
209
|
+
# @!attribute [rw] common
|
210
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
211
|
+
# Some settings.
|
212
|
+
# @!attribute [rw] renamed_services
|
213
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
214
|
+
# Map from original service names to renamed versions.
|
215
|
+
# This is used when the default generated types
|
216
|
+
# would cause a naming conflict. (Neither name is
|
217
|
+
# fully-qualified.)
|
218
|
+
# Example: Subscriber to SubscriberServiceApi.
|
219
|
+
# @!attribute [rw] renamed_resources
|
220
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
221
|
+
# Map from full resource types to the effective short name
|
222
|
+
# for the resource. This is used when otherwise resource
|
223
|
+
# named from different services would cause naming collisions.
|
224
|
+
# Example entry:
|
225
|
+
# "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
226
|
+
# @!attribute [rw] ignored_resources
|
227
|
+
# @return [::Array<::String>]
|
228
|
+
# List of full resource types to ignore during generation.
|
229
|
+
# This is typically used for API-specific Location resources,
|
230
|
+
# which should be handled by the generator as if they were actually
|
231
|
+
# the common Location resources.
|
232
|
+
# Example entry: "documentai.googleapis.com/Location"
|
233
|
+
# @!attribute [rw] forced_namespace_aliases
|
234
|
+
# @return [::Array<::String>]
|
235
|
+
# Namespaces which must be aliased in snippets due to
|
236
|
+
# a known (but non-generator-predictable) naming collision
|
237
|
+
# @!attribute [rw] handwritten_signatures
|
238
|
+
# @return [::Array<::String>]
|
239
|
+
# Method signatures (in the form "service.method(signature)")
|
240
|
+
# which are provided separately, so shouldn't be generated.
|
241
|
+
# Snippets *calling* these methods are still generated, however.
|
242
|
+
class DotnetSettings
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
|
+
|
246
|
+
# @!attribute [rw] key
|
247
|
+
# @return [::String]
|
248
|
+
# @!attribute [rw] value
|
249
|
+
# @return [::String]
|
250
|
+
class RenamedServicesEntry
|
251
|
+
include ::Google::Protobuf::MessageExts
|
252
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
253
|
+
end
|
254
|
+
|
255
|
+
# @!attribute [rw] key
|
256
|
+
# @return [::String]
|
257
|
+
# @!attribute [rw] value
|
258
|
+
# @return [::String]
|
259
|
+
class RenamedResourcesEntry
|
260
|
+
include ::Google::Protobuf::MessageExts
|
261
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
262
|
+
end
|
263
|
+
end
|
264
|
+
|
265
|
+
# Settings for Ruby client libraries.
|
266
|
+
# @!attribute [rw] common
|
267
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
268
|
+
# Some settings.
|
269
|
+
class RubySettings
|
270
|
+
include ::Google::Protobuf::MessageExts
|
271
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
272
|
+
end
|
273
|
+
|
274
|
+
# Settings for Go client libraries.
|
275
|
+
# @!attribute [rw] common
|
276
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
277
|
+
# Some settings.
|
278
|
+
class GoSettings
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
|
283
|
+
# Describes the generator configuration for a method.
|
284
|
+
# @!attribute [rw] selector
|
285
|
+
# @return [::String]
|
286
|
+
# The fully qualified name of the method, for which the options below apply.
|
287
|
+
# This is used to find the method to apply the options.
|
288
|
+
# @!attribute [rw] long_running
|
289
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
290
|
+
# Describes settings to use for long-running operations when generating
|
291
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
292
|
+
# google/longrunning/operations.proto.
|
293
|
+
#
|
294
|
+
# Example of a YAML configuration::
|
295
|
+
#
|
296
|
+
# publishing:
|
297
|
+
# method_settings:
|
298
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
299
|
+
# long_running:
|
300
|
+
# initial_poll_delay:
|
301
|
+
# seconds: 60 # 1 minute
|
302
|
+
# poll_delay_multiplier: 1.5
|
303
|
+
# max_poll_delay:
|
304
|
+
# seconds: 360 # 6 minutes
|
305
|
+
# total_poll_timeout:
|
306
|
+
# seconds: 54000 # 90 minutes
|
307
|
+
class MethodSettings
|
308
|
+
include ::Google::Protobuf::MessageExts
|
309
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
310
|
+
|
311
|
+
# Describes settings to use when generating API methods that use the
|
312
|
+
# long-running operation pattern.
|
313
|
+
# All default values below are from those used in the client library
|
314
|
+
# generators (e.g.
|
315
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
316
|
+
# @!attribute [rw] initial_poll_delay
|
317
|
+
# @return [::Google::Protobuf::Duration]
|
318
|
+
# Initial delay after which the first poll request will be made.
|
319
|
+
# Default value: 5 seconds.
|
320
|
+
# @!attribute [rw] poll_delay_multiplier
|
321
|
+
# @return [::Float]
|
322
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
323
|
+
# reaches max_poll_delay.
|
324
|
+
# Default value: 1.5.
|
325
|
+
# @!attribute [rw] max_poll_delay
|
326
|
+
# @return [::Google::Protobuf::Duration]
|
327
|
+
# Maximum time between two subsequent poll requests.
|
328
|
+
# Default value: 45 seconds.
|
329
|
+
# @!attribute [rw] total_poll_timeout
|
330
|
+
# @return [::Google::Protobuf::Duration]
|
331
|
+
# Total polling timeout.
|
332
|
+
# Default value: 5 minutes.
|
333
|
+
class LongRunning
|
334
|
+
include ::Google::Protobuf::MessageExts
|
335
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
336
|
+
end
|
337
|
+
end
|
338
|
+
|
339
|
+
# The organization for which the client libraries are being published.
|
340
|
+
# Affects the url where generated docs are published, etc.
|
341
|
+
module ClientLibraryOrganization
|
342
|
+
# Not useful.
|
343
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
344
|
+
|
345
|
+
# Google Cloud Platform Org.
|
346
|
+
CLOUD = 1
|
347
|
+
|
348
|
+
# Ads (Advertising) Org.
|
349
|
+
ADS = 2
|
350
|
+
|
351
|
+
# Photos Org.
|
352
|
+
PHOTOS = 3
|
353
|
+
|
354
|
+
# Street View Org.
|
355
|
+
STREET_VIEW = 4
|
356
|
+
|
357
|
+
# Shopping Org.
|
358
|
+
SHOPPING = 5
|
359
|
+
|
360
|
+
# Geo Org.
|
361
|
+
GEO = 6
|
362
|
+
|
363
|
+
# Generative AI - https://developers.generativeai.google
|
364
|
+
GENERATIVE_AI = 7
|
365
|
+
end
|
366
|
+
|
367
|
+
# To where should client libraries be published?
|
368
|
+
module ClientLibraryDestination
|
369
|
+
# Client libraries will neither be generated nor published to package
|
370
|
+
# managers.
|
371
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
372
|
+
|
373
|
+
# Generate the client library in a repo under github.com/googleapis,
|
374
|
+
# but don't publish it to package managers.
|
375
|
+
GITHUB = 10
|
376
|
+
|
377
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
378
|
+
PACKAGE_MANAGER = 20
|
379
|
+
end
|
380
|
+
end
|
381
|
+
end
|
@@ -76,8 +76,10 @@ module Google
|
|
76
76
|
# and is documented together with service config validation.
|
77
77
|
# @!attribute [rw] summary
|
78
78
|
# @return [::String]
|
79
|
-
# A short
|
80
|
-
#
|
79
|
+
# A short description of what the service does. The summary must be plain
|
80
|
+
# text. It becomes the overview of the service displayed in Google Cloud
|
81
|
+
# Console.
|
82
|
+
# NOTE: This field is equivalent to the standard field `description`.
|
81
83
|
# @!attribute [rw] pages
|
82
84
|
# @return [::Array<::Google::Api::Page>]
|
83
85
|
# The top level pages for the documentation set.
|
@@ -118,15 +120,18 @@ module Google
|
|
118
120
|
# A documentation rule provides information about individual API elements.
|
119
121
|
# @!attribute [rw] selector
|
120
122
|
# @return [::String]
|
121
|
-
# The selector is a comma-separated list of patterns
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
123
|
+
# The selector is a comma-separated list of patterns for any element such as
|
124
|
+
# a method, a field, an enum value. Each pattern is a qualified name of the
|
125
|
+
# element which may end in "*", indicating a wildcard. Wildcards are only
|
126
|
+
# allowed at the end and for a whole component of the qualified name,
|
127
|
+
# i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
|
128
|
+
# one or more components. To specify a default for all applicable elements,
|
129
|
+
# the whole pattern "*" is used.
|
127
130
|
# @!attribute [rw] description
|
128
131
|
# @return [::String]
|
129
|
-
# Description of the selected
|
132
|
+
# Description of the selected proto element (e.g. a message, a method, a
|
133
|
+
# 'service' definition, or a field). Defaults to leading & trailing comments
|
134
|
+
# taken from the proto source definition of the proto element.
|
130
135
|
# @!attribute [rw] deprecation_description
|
131
136
|
# @return [::String]
|
132
137
|
# Deprecation description of the selected element(s). It can be provided if
|
@@ -157,7 +162,8 @@ module Google
|
|
157
162
|
# @!attribute [rw] content
|
158
163
|
# @return [::String]
|
159
164
|
# The Markdown content of the page. You can use <code>(== include \\{path}
|
160
|
-
# ==)</code> to include content from a Markdown file.
|
165
|
+
# ==)</code> to include content from a Markdown file. The content can be
|
166
|
+
# used to produce the documentation page such as HTML format page.
|
161
167
|
# @!attribute [rw] subpages
|
162
168
|
# @return [::Array<::Google::Api::Page>]
|
163
169
|
# Subpages of this page. The order of subpages specified here will be
|
@@ -19,21 +19,26 @@
|
|
19
19
|
|
20
20
|
module Google
|
21
21
|
module Api
|
22
|
-
# `Endpoint` describes a network
|
22
|
+
# `Endpoint` describes a network address of a service that serves a set of
|
23
23
|
# APIs. It is commonly known as a service endpoint. A service may expose
|
24
24
|
# any number of service endpoints, and all service endpoints share the same
|
25
25
|
# service definition, such as quota limits and monitoring metrics.
|
26
26
|
#
|
27
|
-
# Example
|
27
|
+
# Example:
|
28
28
|
#
|
29
|
+
# type: google.api.Service
|
29
30
|
# name: library-example.googleapis.com
|
30
31
|
# endpoints:
|
31
|
-
# #
|
32
|
-
# #
|
33
|
-
# #
|
34
|
-
# #
|
35
|
-
# # allowed to proceed.
|
32
|
+
# # Declares network address `https://library-example.googleapis.com`
|
33
|
+
# # for service `library-example.googleapis.com`. The `https` scheme
|
34
|
+
# # is implicit for all service endpoints. Other schemes may be
|
35
|
+
# # supported in the future.
|
36
36
|
# - name: library-example.googleapis.com
|
37
|
+
# allow_cors: false
|
38
|
+
# - name: content-staging-library-example.googleapis.com
|
39
|
+
# # Allows HTTP OPTIONS calls to be passed to the API frontend, for it
|
40
|
+
# # to decide whether the subsequent cross-origin request is allowed
|
41
|
+
# # to proceed.
|
37
42
|
# allow_cors: true
|
38
43
|
# @!attribute [rw] name
|
39
44
|
# @return [::String]
|
@@ -43,8 +48,8 @@ module Google
|
|
43
48
|
# Unimplemented. Dot not use.
|
44
49
|
#
|
45
50
|
# DEPRECATED: This field is no longer supported. Instead of using aliases,
|
46
|
-
# please specify multiple {::Google::Api::Endpoint google.api.Endpoint} for each
|
47
|
-
# aliases.
|
51
|
+
# please specify multiple {::Google::Api::Endpoint google.api.Endpoint} for each
|
52
|
+
# of the intended aliases.
|
48
53
|
#
|
49
54
|
# Additional names that this endpoint will be hosted on.
|
50
55
|
# @!attribute [rw] target
|
@@ -20,7 +20,7 @@
|
|
20
20
|
module Google
|
21
21
|
module Api
|
22
22
|
# The launch stage as defined by [Google Cloud Platform
|
23
|
-
# Launch Stages](
|
23
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
24
24
|
module LaunchStage
|
25
25
|
# Do not use this default value.
|
26
26
|
LAUNCH_STAGE_UNSPECIFIED = 0
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# for widespread use. By Alpha, all significant design issues are resolved
|
43
43
|
# and we are in the process of verifying functionality. Alpha customers
|
44
44
|
# need to apply for access, agree to applicable terms, and have their
|
45
|
-
# projects allowlisted. Alpha releases don
|
45
|
+
# projects allowlisted. Alpha releases don't have to be feature complete,
|
46
46
|
# no SLAs are provided, and there are no technical support obligations, but
|
47
47
|
# they will be far enough along that customers can actually use them in
|
48
48
|
# test environments or for limited-use tests -- just like they would in
|
@@ -61,7 +61,7 @@ module Google
|
|
61
61
|
GA = 4
|
62
62
|
|
63
63
|
# Deprecated features are scheduled to be shut down and removed. For more
|
64
|
-
# information, see the
|
64
|
+
# information, see the "Deprecation Policy" section of our [Terms of
|
65
65
|
# Service](https://cloud.google.com/terms/)
|
66
66
|
# and the [Google Cloud Platform Subject to the Deprecation
|
67
67
|
# Policy](https://cloud.google.com/terms/deprecation) documentation.
|
@@ -19,9 +19,10 @@
|
|
19
19
|
|
20
20
|
module Google
|
21
21
|
module Api
|
22
|
-
# An object that describes the schema of a
|
23
|
-
#
|
24
|
-
#
|
22
|
+
# An object that describes the schema of a
|
23
|
+
# {::Google::Api::MonitoredResource MonitoredResource} object using a type name
|
24
|
+
# and a set of labels. For example, the monitored resource descriptor for
|
25
|
+
# Google Compute Engine VM instances has a type of
|
25
26
|
# `"gce_instance"` and specifies the use of the labels `"instance_id"` and
|
26
27
|
# `"zone"` to identify particular VM instances.
|
27
28
|
#
|
@@ -40,6 +41,10 @@ module Google
|
|
40
41
|
# @return [::String]
|
41
42
|
# Required. The monitored resource type. For example, the type
|
42
43
|
# `"cloudsql_database"` represents databases in Google Cloud SQL.
|
44
|
+
# For a list of types, see [Monitoring resource
|
45
|
+
# types](https://cloud.google.com/monitoring/api/resources)
|
46
|
+
# and [Logging resource
|
47
|
+
# types](https://cloud.google.com/logging/docs/api/v2/resource-list).
|
43
48
|
# @!attribute [rw] display_name
|
44
49
|
# @return [::String]
|
45
50
|
# Optional. A concise name for the monitored resource type that might be
|
@@ -66,21 +71,28 @@ module Google
|
|
66
71
|
# An object representing a resource that can be used for monitoring, logging,
|
67
72
|
# billing, or other purposes. Examples include virtual machine instances,
|
68
73
|
# databases, and storage devices such as disks. The `type` field identifies a
|
69
|
-
# {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object
|
70
|
-
# schema. Information in the `labels` field
|
71
|
-
# its attributes according to the schema.
|
72
|
-
# Engine VM instance could be represented by
|
73
|
-
#
|
74
|
-
#
|
74
|
+
# {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object
|
75
|
+
# that describes the resource's schema. Information in the `labels` field
|
76
|
+
# identifies the actual resource and its attributes according to the schema.
|
77
|
+
# For example, a particular Compute Engine VM instance could be represented by
|
78
|
+
# the following object, because the
|
79
|
+
# {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for
|
80
|
+
# `"gce_instance"` has labels
|
81
|
+
# `"project_id"`, `"instance_id"` and `"zone"`:
|
75
82
|
#
|
76
83
|
# { "type": "gce_instance",
|
77
|
-
# "labels": { "
|
84
|
+
# "labels": { "project_id": "my-project",
|
85
|
+
# "instance_id": "12345678901234",
|
78
86
|
# "zone": "us-central1-a" }}
|
79
87
|
# @!attribute [rw] type
|
80
88
|
# @return [::String]
|
81
89
|
# Required. The monitored resource type. This field must match
|
82
|
-
# the `type` field of a
|
83
|
-
#
|
90
|
+
# the `type` field of a
|
91
|
+
# {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor}
|
92
|
+
# object. For example, the type of a Compute Engine VM instance is
|
93
|
+
# `gce_instance`. Some descriptors include the service name in the type; for
|
94
|
+
# example, the type of a Datastream stream is
|
95
|
+
# `datastream.googleapis.com/Stream`.
|
84
96
|
# @!attribute [rw] labels
|
85
97
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
86
98
|
# Required. Values for all of the labels listed in the associated monitored
|
@@ -100,12 +112,12 @@ module Google
|
|
100
112
|
end
|
101
113
|
end
|
102
114
|
|
103
|
-
# Auxiliary metadata for a {::Google::Api::MonitoredResource MonitoredResource}
|
104
|
-
# {::Google::Api::MonitoredResource MonitoredResource} objects contain the
|
105
|
-
# uniquely identify a monitored resource
|
106
|
-
# auxiliary metadata. Monitoring and
|
107
|
-
# pipeline to extract metadata for cloud resources of
|
108
|
-
# the metadata in this message.
|
115
|
+
# Auxiliary metadata for a {::Google::Api::MonitoredResource MonitoredResource}
|
116
|
+
# object. {::Google::Api::MonitoredResource MonitoredResource} objects contain the
|
117
|
+
# minimum set of information to uniquely identify a monitored resource
|
118
|
+
# instance. There is some other useful auxiliary metadata. Monitoring and
|
119
|
+
# Logging use an ingestion pipeline to extract metadata for cloud resources of
|
120
|
+
# all types, and store the metadata in this message.
|
109
121
|
# @!attribute [rw] system_labels
|
110
122
|
# @return [::Google::Protobuf::Struct]
|
111
123
|
# Output only. Values for predefined system metadata labels.
|
@@ -96,11 +96,13 @@ module Google
|
|
96
96
|
# @!attribute [rw] monitored_resource
|
97
97
|
# @return [::String]
|
98
98
|
# The monitored resource type. The type must be defined in
|
99
|
-
# [Service.monitored_resources][google.api.Service.monitored_resources]
|
99
|
+
# [Service.monitored_resources][google.api.Service.monitored_resources]
|
100
|
+
# section.
|
100
101
|
# @!attribute [rw] metrics
|
101
102
|
# @return [::Array<::String>]
|
102
103
|
# Types of the metrics to report to this monitoring destination.
|
103
|
-
# Each type must be defined in
|
104
|
+
# Each type must be defined in
|
105
|
+
# [Service.metrics][google.api.Service.metrics] section.
|
104
106
|
class MonitoringDestination
|
105
107
|
include ::Google::Protobuf::MessageExts
|
106
108
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -41,10 +41,10 @@ module Google
|
|
41
41
|
# STANDARD: 10000
|
42
42
|
#
|
43
43
|
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
44
|
+
# (The metric rules bind all methods to the read_calls metric,
|
45
|
+
# except for the UpdateBook and DeleteBook methods. These two methods
|
46
|
+
# are mapped to the write_calls metric, with the UpdateBook method
|
47
|
+
# consuming at twice rate as the DeleteBook method.)
|
48
48
|
# metric_rules:
|
49
49
|
# - selector: "*"
|
50
50
|
# metric_costs:
|
@@ -70,10 +70,10 @@ module Google
|
|
70
70
|
# value_type: INT64
|
71
71
|
# @!attribute [rw] limits
|
72
72
|
# @return [::Array<::Google::Api::QuotaLimit>]
|
73
|
-
# List of
|
73
|
+
# List of QuotaLimit definitions for the service.
|
74
74
|
# @!attribute [rw] metric_rules
|
75
75
|
# @return [::Array<::Google::Api::MetricRule>]
|
76
|
-
# List of
|
76
|
+
# List of MetricRule definitions, each one mapping a selected method to one
|
77
77
|
# or more metrics.
|
78
78
|
class Quota
|
79
79
|
include ::Google::Protobuf::MessageExts
|
@@ -86,7 +86,8 @@ module Google
|
|
86
86
|
# @return [::String]
|
87
87
|
# Selects the methods to which this rule applies.
|
88
88
|
#
|
89
|
-
# Refer to {::Google::Api::DocumentationRule#selector selector} for syntax
|
89
|
+
# Refer to {::Google::Api::DocumentationRule#selector selector} for syntax
|
90
|
+
# details.
|
90
91
|
# @!attribute [rw] metric_costs
|
91
92
|
# @return [::Google::Protobuf::Map{::String => ::Integer}]
|
92
93
|
# Metrics to update when the selected methods are called, and the associated
|
@@ -81,7 +81,8 @@ module Google
|
|
81
81
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
82
82
|
# methods in all APIs.
|
83
83
|
#
|
84
|
-
# Refer to {::Google::Api::DocumentationRule#selector selector} for syntax
|
84
|
+
# Refer to {::Google::Api::DocumentationRule#selector selector} for syntax
|
85
|
+
# details.
|
85
86
|
# @!attribute [rw] allow_unregistered_calls
|
86
87
|
# @return [::Boolean]
|
87
88
|
# If true, the selected method allows unregistered calls, e.g. calls
|