google-cloud-service_management-v1 0.3.9 → 0.4.1

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.
@@ -0,0 +1,318 @@
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.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -19,13 +19,17 @@
19
19
 
20
20
  module Google
21
21
  module Api
22
- # Selects and configures the service controller used by the service. The
23
- # service controller handles features like abuse, quota, billing, logging,
24
- # monitoring, etc.
22
+ # Selects and configures the service controller used by the service.
23
+ #
24
+ # Example:
25
+ #
26
+ # control:
27
+ # environment: servicecontrol.googleapis.com
25
28
  # @!attribute [rw] environment
26
29
  # @return [::String]
27
- # The service control environment to use. If empty, no control plane
28
- # feature (like quota and billing) will be enabled.
30
+ # The service controller environment to use. If empty, no control plane
31
+ # feature (like quota and billing) will be enabled. The recommended value for
32
+ # most services is servicecontrol.googleapis.com
29
33
  class Control
30
34
  include ::Google::Protobuf::MessageExts
31
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -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 summary of what the service does. Can only be provided by
80
- # plain text.
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. Each pattern is a
122
- # qualified name of the element which may end in "*", indicating a wildcard.
123
- # Wildcards are only allowed at the end and for a whole component of the
124
- # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A
125
- # wildcard will match one or more components. To specify a default for all
126
- # applicable elements, the whole pattern "*" is used.
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 API(s).
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>&#40;== include \\{path}
160
- # ==&#41;</code> to include content from a Markdown file.
165
+ # ==&#41;</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 endpoint of a service that serves a set of
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 service configuration:
27
+ # Example:
28
28
  #
29
+ # type: google.api.Service
29
30
  # name: library-example.googleapis.com
30
31
  # endpoints:
31
- # # Below entry makes 'google.example.library.v1.Library'
32
- # # API be served from endpoint address library-example.googleapis.com.
33
- # # It also allows HTTP OPTIONS calls to be passed to the backend, for
34
- # # it to decide whether the subsequent cross-origin request is
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 of the intended
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](http://cloud.google.com/terms/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 dont have to be feature complete,
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 Deprecation Policy section of our [Terms of
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.
@@ -40,6 +40,10 @@ module Google
40
40
  # @return [::String]
41
41
  # Required. The monitored resource type. For example, the type
42
42
  # `"cloudsql_database"` represents databases in Google Cloud SQL.
43
+ # For a list of types, see [Monitoring resource
44
+ # types](https://cloud.google.com/monitoring/api/resources)
45
+ # and [Logging resource
46
+ # types](https://cloud.google.com/logging/docs/api/v2/resource-list).
43
47
  # @!attribute [rw] display_name
44
48
  # @return [::String]
45
49
  # Optional. A concise name for the monitored resource type that might be
@@ -71,16 +75,19 @@ module Google
71
75
  # its attributes according to the schema. For example, a particular Compute
72
76
  # Engine VM instance could be represented by the following object, because the
73
77
  # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
74
- # `"instance_id"` and `"zone"`:
78
+ # `"project_id"`, `"instance_id"` and `"zone"`:
75
79
  #
76
80
  # { "type": "gce_instance",
77
- # "labels": { "instance_id": "12345678901234",
81
+ # "labels": { "project_id": "my-project",
82
+ # "instance_id": "12345678901234",
78
83
  # "zone": "us-central1-a" }}
79
84
  # @!attribute [rw] type
80
85
  # @return [::String]
81
86
  # Required. The monitored resource type. This field must match
82
87
  # the `type` field of a {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
83
88
  # example, the type of a Compute Engine VM instance is `gce_instance`.
89
+ # Some descriptors include the service name in the type; for example,
90
+ # the type of a Datastream stream is `datastream.googleapis.com/Stream`.
84
91
  # @!attribute [rw] labels
85
92
  # @return [::Google::Protobuf::Map{::String => ::String}]
86
93
  # Required. Values for all of the labels listed in the associated monitored
@@ -41,10 +41,10 @@ module Google
41
41
  # STANDARD: 10000
42
42
  #
43
43
  #
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.
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 `QuotaLimit` definitions for the service.
73
+ # List of QuotaLimit definitions for the service.
74
74
  # @!attribute [rw] metric_rules
75
75
  # @return [::Array<::Google::Api::MetricRule>]
76
- # List of `MetricRule` definitions, each one mapping a selected method to one
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
@@ -19,11 +19,12 @@
19
19
 
20
20
  module Google
21
21
  module Api
22
- # `Service` is the root object of Google service configuration schema. It
23
- # describes basic information about a service, such as the name and the
24
- # title, and delegates other aspects to sub-sections. Each sub-section is
25
- # either a proto message or a repeated proto message that configures a
26
- # specific aspect, such as auth. See each proto message definition for details.
22
+ # `Service` is the root object of Google API service configuration (service
23
+ # config). It describes the basic information about a logical service,
24
+ # such as the service name and the user-facing title, and delegates other
25
+ # aspects to sub-sections. Each sub-section is either a proto message or a
26
+ # repeated proto message that configures a specific aspect, such as auth.
27
+ # For more information, see each proto message definition.
27
28
  #
28
29
  # Example:
29
30
  #
@@ -32,6 +33,16 @@ module Google
32
33
  # title: Google Calendar API
33
34
  # apis:
34
35
  # - name: google.calendar.v3.Calendar
36
+ #
37
+ # visibility:
38
+ # rules:
39
+ # - selector: "google.calendar.v3.*"
40
+ # restriction: PREVIEW
41
+ # backend:
42
+ # rules:
43
+ # - selector: "google.calendar.v3.*"
44
+ # address: calendar.example.com
45
+ #
35
46
  # authentication:
36
47
  # providers:
37
48
  # - id: google_calendar_auth
@@ -49,7 +60,8 @@ module Google
49
60
  # of the service also owns the DNS name.
50
61
  # @!attribute [rw] title
51
62
  # @return [::String]
52
- # The product title for this service.
63
+ # The product title for this service, it is the name displayed in Google
64
+ # Cloud Console.
53
65
  # @!attribute [rw] producer_project_id
54
66
  # @return [::String]
55
67
  # The Google project that owns this service.
@@ -69,19 +81,19 @@ module Google
69
81
  # @!attribute [rw] types
70
82
  # @return [::Array<::Google::Protobuf::Type>]
71
83
  # A list of all proto message types included in this API service.
72
- # Types referenced directly or indirectly by the `apis` are
73
- # automatically included. Messages which are not referenced but
74
- # shall be included, such as types used by the `google.protobuf.Any` type,
75
- # should be listed here by name. Example:
84
+ # Types referenced directly or indirectly by the `apis` are automatically
85
+ # included. Messages which are not referenced but shall be included, such as
86
+ # types used by the `google.protobuf.Any` type, should be listed here by
87
+ # name by the configuration author. Example:
76
88
  #
77
89
  # types:
78
90
  # - name: google.protobuf.Int32
79
91
  # @!attribute [rw] enums
80
92
  # @return [::Array<::Google::Protobuf::Enum>]
81
- # A list of all enum types included in this API service. Enums
82
- # referenced directly or indirectly by the `apis` are automatically
83
- # included. Enums which are not referenced but shall be included
84
- # should be listed here by name. Example:
93
+ # A list of all enum types included in this API service. Enums referenced
94
+ # directly or indirectly by the `apis` are automatically included. Enums
95
+ # which are not referenced but shall be included should be listed here by
96
+ # name by the configuration author. Example:
85
97
  #
86
98
  # enums:
87
99
  # - name: google.someapi.v1.SomeEnum
@@ -139,6 +151,11 @@ module Google
139
151
  # @!attribute [rw] source_info
140
152
  # @return [::Google::Api::SourceInfo]
141
153
  # Output only. The source information for this configuration if available.
154
+ # @!attribute [rw] publishing
155
+ # @return [::Google::Api::Publishing]
156
+ # Settings for [Google Cloud Client
157
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
158
+ # generated from APIs defined as protocol buffers.
142
159
  # @!attribute [rw] config_version
143
160
  # @return [::Google::Protobuf::UInt32Value]
144
161
  # Obsolete. Do not use.