google-cloud-service_management-v1 0.3.10 → 0.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +11 -6
- data/lib/google/api/servicemanagement/v1/resources_pb.rb +2 -1
- data/lib/google/api/servicemanagement/v1/servicemanager_pb.rb +2 -1
- data/lib/google/cloud/service_management/v1/service_manager/client.rb +32 -38
- data/lib/google/cloud/service_management/v1/service_manager/operations.rb +15 -22
- data/lib/google/cloud/service_management/v1/service_manager.rb +1 -1
- data/lib/google/cloud/service_management/v1/version.rb +1 -1
- data/lib/google/cloud/service_management/v1.rb +2 -2
- data/proto_docs/google/api/auth.rb +8 -4
- data/proto_docs/google/api/backend.rb +1 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/control.rb +9 -5
- 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 +9 -2
- data/proto_docs/google/api/quota.rb +6 -6
- data/proto_docs/google/api/service.rb +31 -14
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/protobuf/struct.rb +2 -2
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +13 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 03f4dc2595c7118c2a16e8fa0e0f77f9f9cab355dc64c927909a78d94dc177e0
|
4
|
+
data.tar.gz: b842c89933411133dd53146805eedb0abd5b3296bb51555b11e9cf54ff86d54b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bcc0d1145fda817cd74d0b78b79462da99f7766981d1a5f5676b874466c069a3268149dbce115402815c02491050a84386b502877d17deeccd563b15f30f161b
|
7
|
+
data.tar.gz: 7aee4154d0c7e9ab58d18519cd703fc09e144da3fb9bd45c0993acecd6dae337ec399a39dd6d74c32f19ed39137068b02d93c80fd4f22d623f649c2833d8f7fd
|
data/AUTHENTICATION.md
CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
|
|
114
114
|
To configure your system for this, simply:
|
115
115
|
|
116
116
|
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
117
|
-
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
|
117
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
|
118
118
|
3. Write code as if already authenticated.
|
119
119
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
data/README.md
CHANGED
@@ -46,7 +46,7 @@ for general usage information.
|
|
46
46
|
## Enabling Logging
|
47
47
|
|
48
48
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
49
|
-
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/
|
49
|
+
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
50
50
|
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
51
51
|
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
52
52
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
@@ -69,16 +69,21 @@ module GRPC
|
|
69
69
|
end
|
70
70
|
```
|
71
71
|
|
72
|
+
|
73
|
+
## Google Cloud Samples
|
74
|
+
|
75
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
76
|
+
|
72
77
|
## Supported Ruby Versions
|
73
78
|
|
74
|
-
This library is supported on Ruby 2.
|
79
|
+
This library is supported on Ruby 2.6+.
|
75
80
|
|
76
81
|
Google provides official support for Ruby versions that are actively supported
|
77
82
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
78
|
-
in security maintenance, and not end of life.
|
79
|
-
|
80
|
-
|
81
|
-
|
83
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
84
|
+
still work, but are unsupported and not recommended. See
|
85
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
86
|
+
support schedule.
|
82
87
|
|
83
88
|
## Which client should I use?
|
84
89
|
|
@@ -1,10 +1,11 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/api/servicemanagement/v1/resources.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/config_change_pb'
|
5
7
|
require 'google/api/field_behavior_pb'
|
6
8
|
require 'google/protobuf/timestamp_pb'
|
7
|
-
require 'google/protobuf'
|
8
9
|
|
9
10
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
11
|
add_file("google/api/servicemanagement/v1/resources.proto", :syntax => :proto3) do
|
@@ -1,6 +1,8 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/api/servicemanagement/v1/servicemanager.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/annotations_pb'
|
5
7
|
require 'google/api/client_pb'
|
6
8
|
require 'google/api/field_behavior_pb'
|
@@ -8,7 +10,6 @@ require 'google/api/service_pb'
|
|
8
10
|
require 'google/api/servicemanagement/v1/resources_pb'
|
9
11
|
require 'google/longrunning/operations_pb'
|
10
12
|
require 'google/protobuf/any_pb'
|
11
|
-
require 'google/protobuf'
|
12
13
|
|
13
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
15
|
add_file("google/api/servicemanagement/v1/servicemanager.proto", :syntax => :proto3) do
|
@@ -215,13 +215,11 @@ module Google
|
|
215
215
|
# # Call the list_services method.
|
216
216
|
# result = client.list_services request
|
217
217
|
#
|
218
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
219
|
-
# #
|
220
|
-
#
|
221
|
-
# # methods are also available for managing paging directly.
|
222
|
-
# result.each do |response|
|
218
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
219
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
220
|
+
# result.each do |item|
|
223
221
|
# # Each element is of type ::Google::Cloud::ServiceManagement::V1::ManagedService.
|
224
|
-
# p
|
222
|
+
# p item
|
225
223
|
# end
|
226
224
|
#
|
227
225
|
def list_services request, options = nil
|
@@ -396,14 +394,14 @@ module Google
|
|
396
394
|
# # Call the create_service method.
|
397
395
|
# result = client.create_service request
|
398
396
|
#
|
399
|
-
# # The returned object is of type Gapic::Operation. You can use
|
400
|
-
# #
|
401
|
-
# #
|
397
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
398
|
+
# # check the status of an operation, cancel it, or wait for results.
|
399
|
+
# # Here is how to wait for a response.
|
402
400
|
# result.wait_until_done! timeout: 60
|
403
401
|
# if result.response?
|
404
402
|
# p result.response
|
405
403
|
# else
|
406
|
-
# puts "
|
404
|
+
# puts "No response received."
|
407
405
|
# end
|
408
406
|
#
|
409
407
|
def create_service request, options = nil
|
@@ -490,14 +488,14 @@ module Google
|
|
490
488
|
# # Call the delete_service method.
|
491
489
|
# result = client.delete_service request
|
492
490
|
#
|
493
|
-
# # The returned object is of type Gapic::Operation. You can use
|
494
|
-
# #
|
495
|
-
# #
|
491
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
492
|
+
# # check the status of an operation, cancel it, or wait for results.
|
493
|
+
# # Here is how to wait for a response.
|
496
494
|
# result.wait_until_done! timeout: 60
|
497
495
|
# if result.response?
|
498
496
|
# p result.response
|
499
497
|
# else
|
500
|
-
# puts "
|
498
|
+
# puts "No response received."
|
501
499
|
# end
|
502
500
|
#
|
503
501
|
def delete_service request, options = nil
|
@@ -590,14 +588,14 @@ module Google
|
|
590
588
|
# # Call the undelete_service method.
|
591
589
|
# result = client.undelete_service request
|
592
590
|
#
|
593
|
-
# # The returned object is of type Gapic::Operation. You can use
|
594
|
-
# #
|
595
|
-
# #
|
591
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
592
|
+
# # check the status of an operation, cancel it, or wait for results.
|
593
|
+
# # Here is how to wait for a response.
|
596
594
|
# result.wait_until_done! timeout: 60
|
597
595
|
# if result.response?
|
598
596
|
# p result.response
|
599
597
|
# else
|
600
|
-
# puts "
|
598
|
+
# puts "No response received."
|
601
599
|
# end
|
602
600
|
#
|
603
601
|
def undelete_service request, options = nil
|
@@ -691,13 +689,11 @@ module Google
|
|
691
689
|
# # Call the list_service_configs method.
|
692
690
|
# result = client.list_service_configs request
|
693
691
|
#
|
694
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
695
|
-
# #
|
696
|
-
#
|
697
|
-
# # methods are also available for managing paging directly.
|
698
|
-
# result.each do |response|
|
692
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
693
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
694
|
+
# result.each do |item|
|
699
695
|
# # Each element is of type ::Google::Api::Service.
|
700
|
-
# p
|
696
|
+
# p item
|
701
697
|
# end
|
702
698
|
#
|
703
699
|
def list_service_configs request, options = nil
|
@@ -998,14 +994,14 @@ module Google
|
|
998
994
|
# # Call the submit_config_source method.
|
999
995
|
# result = client.submit_config_source request
|
1000
996
|
#
|
1001
|
-
# # The returned object is of type Gapic::Operation. You can use
|
1002
|
-
# #
|
1003
|
-
# #
|
997
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
998
|
+
# # check the status of an operation, cancel it, or wait for results.
|
999
|
+
# # Here is how to wait for a response.
|
1004
1000
|
# result.wait_until_done! timeout: 60
|
1005
1001
|
# if result.response?
|
1006
1002
|
# p result.response
|
1007
1003
|
# else
|
1008
|
-
# puts "
|
1004
|
+
# puts "No response received."
|
1009
1005
|
# end
|
1010
1006
|
#
|
1011
1007
|
def submit_config_source request, options = nil
|
@@ -1108,13 +1104,11 @@ module Google
|
|
1108
1104
|
# # Call the list_service_rollouts method.
|
1109
1105
|
# result = client.list_service_rollouts request
|
1110
1106
|
#
|
1111
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
1112
|
-
# #
|
1113
|
-
#
|
1114
|
-
# # methods are also available for managing paging directly.
|
1115
|
-
# result.each do |response|
|
1107
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1108
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1109
|
+
# result.each do |item|
|
1116
1110
|
# # Each element is of type ::Google::Cloud::ServiceManagement::V1::Rollout.
|
1117
|
-
# p
|
1111
|
+
# p item
|
1118
1112
|
# end
|
1119
1113
|
#
|
1120
1114
|
def list_service_rollouts request, options = nil
|
@@ -1310,14 +1304,14 @@ module Google
|
|
1310
1304
|
# # Call the create_service_rollout method.
|
1311
1305
|
# result = client.create_service_rollout request
|
1312
1306
|
#
|
1313
|
-
# # The returned object is of type Gapic::Operation. You can use
|
1314
|
-
# #
|
1315
|
-
# #
|
1307
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1308
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1309
|
+
# # Here is how to wait for a response.
|
1316
1310
|
# result.wait_until_done! timeout: 60
|
1317
1311
|
# if result.response?
|
1318
1312
|
# p result.response
|
1319
1313
|
# else
|
1320
|
-
# puts "
|
1314
|
+
# puts "No response received."
|
1321
1315
|
# end
|
1322
1316
|
#
|
1323
1317
|
def create_service_rollout request, options = nil
|
@@ -95,6 +95,9 @@ module Google
|
|
95
95
|
channel_args: @config.channel_args,
|
96
96
|
interceptors: @config.interceptors
|
97
97
|
)
|
98
|
+
|
99
|
+
# Used by an LRO wrapper for some methods of this service
|
100
|
+
@operations_client = self
|
98
101
|
end
|
99
102
|
|
100
103
|
# Service calls
|
@@ -155,13 +158,11 @@ module Google
|
|
155
158
|
# # Call the list_operations method.
|
156
159
|
# result = client.list_operations request
|
157
160
|
#
|
158
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
159
|
-
# #
|
160
|
-
#
|
161
|
-
# # methods are also available for managing paging directly.
|
162
|
-
# result.each do |response|
|
161
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
162
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
163
|
+
# result.each do |item|
|
163
164
|
# # Each element is of type ::Google::Longrunning::Operation.
|
164
|
-
# p
|
165
|
+
# p item
|
165
166
|
# end
|
166
167
|
#
|
167
168
|
def list_operations request, options = nil
|
@@ -181,14 +182,6 @@ module Google
|
|
181
182
|
gapic_version: ::Google::Cloud::ServiceManagement::V1::VERSION
|
182
183
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
183
184
|
|
184
|
-
header_params = {}
|
185
|
-
if request.name
|
186
|
-
header_params["name"] = request.name
|
187
|
-
end
|
188
|
-
|
189
|
-
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
190
|
-
metadata[:"x-goog-request-params"] ||= request_params_header
|
191
|
-
|
192
185
|
options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
|
193
186
|
metadata: metadata,
|
194
187
|
retry_policy: @config.rpcs.list_operations.retry_policy
|
@@ -250,14 +243,14 @@ module Google
|
|
250
243
|
# # Call the get_operation method.
|
251
244
|
# result = client.get_operation request
|
252
245
|
#
|
253
|
-
# # The returned object is of type Gapic::Operation. You can use
|
254
|
-
# #
|
255
|
-
# #
|
246
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
247
|
+
# # check the status of an operation, cancel it, or wait for results.
|
248
|
+
# # Here is how to wait for a response.
|
256
249
|
# result.wait_until_done! timeout: 60
|
257
250
|
# if result.response?
|
258
251
|
# p result.response
|
259
252
|
# else
|
260
|
-
# puts "
|
253
|
+
# puts "No response received."
|
261
254
|
# end
|
262
255
|
#
|
263
256
|
def get_operation request, options = nil
|
@@ -537,14 +530,14 @@ module Google
|
|
537
530
|
# # Call the wait_operation method.
|
538
531
|
# result = client.wait_operation request
|
539
532
|
#
|
540
|
-
# # The returned object is of type Gapic::Operation. You can use
|
541
|
-
# #
|
542
|
-
# #
|
533
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
534
|
+
# # check the status of an operation, cancel it, or wait for results.
|
535
|
+
# # Here is how to wait for a response.
|
543
536
|
# result.wait_until_done! timeout: 60
|
544
537
|
# if result.response?
|
545
538
|
# p result.response
|
546
539
|
# else
|
547
|
-
# puts "
|
540
|
+
# puts "No response received."
|
548
541
|
# end
|
549
542
|
#
|
550
543
|
def wait_operation request, options = nil
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
# [Google Service Management
|
35
35
|
# API](https://cloud.google.com/service-infrastructure/docs/overview)
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/service_management/v1/service_manager"
|
40
40
|
# client = ::Google::Cloud::ServiceManagement::V1::ServiceManager::Client.new
|
@@ -23,9 +23,9 @@ module Google
|
|
23
23
|
module Cloud
|
24
24
|
module ServiceManagement
|
25
25
|
##
|
26
|
-
#
|
26
|
+
# API client module.
|
27
27
|
#
|
28
|
-
# @example
|
28
|
+
# @example Load this package, including all its services, and instantiate a gRPC client
|
29
29
|
#
|
30
30
|
# require "google/cloud/service_management/v1"
|
31
31
|
# client = ::Google::Cloud::ServiceManagement::V1::ServiceManager::Client.new
|
@@ -86,6 +86,9 @@ module Google
|
|
86
86
|
# @!attribute [rw] query
|
87
87
|
# @return [::String]
|
88
88
|
# Specifies URL query parameter name to extract JWT token.
|
89
|
+
# @!attribute [rw] cookie
|
90
|
+
# @return [::String]
|
91
|
+
# Specifies cookie name to extract JWT token.
|
89
92
|
# @!attribute [rw] value_prefix
|
90
93
|
# @return [::String]
|
91
94
|
# The value prefix. The value format is "value_prefix\\{token}"
|
@@ -157,11 +160,12 @@ module Google
|
|
157
160
|
# Implement authorizationUrl of securityDefinitions in OpenAPI spec.
|
158
161
|
# @!attribute [rw] jwt_locations
|
159
162
|
# @return [::Array<::Google::Api::JwtLocation>]
|
160
|
-
# Defines the locations to extract the JWT.
|
163
|
+
# Defines the locations to extract the JWT. For now it is only used by the
|
164
|
+
# Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations]
|
165
|
+
# (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations)
|
161
166
|
#
|
162
|
-
# JWT locations can be
|
163
|
-
# The rule is that the first match wins.
|
164
|
-
# all headers first, then URL query parameters.
|
167
|
+
# JWT locations can be one of HTTP headers, URL query parameters or
|
168
|
+
# cookies. The rule is that the first match wins.
|
165
169
|
#
|
166
170
|
# If not specified, default to use following 3 locations:
|
167
171
|
# 1) Authorization: Bearer
|
@@ -64,8 +64,7 @@ module Google
|
|
64
64
|
# varies based on the request protocol and deployment environment.
|
65
65
|
# @!attribute [rw] min_deadline
|
66
66
|
# @return [::Float]
|
67
|
-
#
|
68
|
-
# value lower than this will be rejected.
|
67
|
+
# Deprecated, do not use.
|
69
68
|
# @!attribute [rw] operation_deadline
|
70
69
|
# @return [::Float]
|
71
70
|
# The number of seconds to wait for the completion of a long running
|
@@ -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.
|
23
|
-
#
|
24
|
-
#
|
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
|
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
|
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.
|
@@ -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": { "
|
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
|
-
#
|
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
|
@@ -19,11 +19,12 @@
|
|
19
19
|
|
20
20
|
module Google
|
21
21
|
module Api
|
22
|
-
# `Service` is the root object of Google service configuration
|
23
|
-
# describes basic information about a service,
|
24
|
-
#
|
25
|
-
#
|
26
|
-
# specific aspect, such as auth.
|
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
|
-
#
|
74
|
-
#
|
75
|
-
#
|
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
|
-
#
|
83
|
-
#
|
84
|
-
#
|
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.
|
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# foo = any.unpack(Foo.class);
|
45
45
|
# }
|
46
46
|
#
|
47
|
-
#
|
47
|
+
# Example 3: Pack and unpack a message in Python.
|
48
48
|
#
|
49
49
|
# foo = Foo(...)
|
50
50
|
# any = Any()
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
# any.Unpack(foo)
|
55
55
|
# ...
|
56
56
|
#
|
57
|
-
#
|
57
|
+
# Example 4: Pack and unpack a message in Go
|
58
58
|
#
|
59
59
|
# foo := &pb.Foo{...}
|
60
60
|
# any, err := anypb.New(foo)
|
@@ -75,7 +75,7 @@ module Google
|
|
75
75
|
#
|
76
76
|
#
|
77
77
|
# JSON
|
78
|
-
#
|
78
|
+
#
|
79
79
|
# The JSON representation of an `Any` value uses the regular
|
80
80
|
# representation of the deserialized, embedded message, with an
|
81
81
|
# additional field `@type` which contains the type URL. Example:
|
@@ -26,8 +26,6 @@ module Google
|
|
26
26
|
# service Foo {
|
27
27
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
28
|
# }
|
29
|
-
#
|
30
|
-
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
29
|
class Empty
|
32
30
|
include ::Google::Protobuf::MessageExts
|
33
31
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -46,8 +46,8 @@ module Google
|
|
46
46
|
|
47
47
|
# `Value` represents a dynamically typed value which can be either
|
48
48
|
# null, a number, a string, a boolean, a recursive struct value, or a
|
49
|
-
# list of values. A producer of value is expected to set one of
|
50
|
-
# variants
|
49
|
+
# list of values. A producer of value is expected to set one of these
|
50
|
+
# variants. Absence of any variant indicates an error.
|
51
51
|
#
|
52
52
|
# The JSON representation for `Value` is JSON value.
|
53
53
|
# @!attribute [rw] null_value
|
@@ -28,12 +28,14 @@ module Google
|
|
28
28
|
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
29
29
|
# @!attribute [rw] code
|
30
30
|
# @return [::Integer]
|
31
|
-
# The status code, which should be an enum value of
|
31
|
+
# The status code, which should be an enum value of
|
32
|
+
# [google.rpc.Code][google.rpc.Code].
|
32
33
|
# @!attribute [rw] message
|
33
34
|
# @return [::String]
|
34
35
|
# A developer-facing error message, which should be in English. Any
|
35
36
|
# user-facing error message should be localized and sent in the
|
36
|
-
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
37
|
+
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
38
|
+
# by the client.
|
37
39
|
# @!attribute [rw] details
|
38
40
|
# @return [::Array<::Google::Protobuf::Any>]
|
39
41
|
# A list of messages that carry the error details. There is a common set of
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-service_management-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-02-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: 0.17.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version:
|
29
|
+
version: 0.17.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,28 +50,28 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: 1.
|
53
|
+
version: 1.26.3
|
54
54
|
type: :development
|
55
55
|
prerelease: false
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
requirements:
|
58
58
|
- - "~>"
|
59
59
|
- !ruby/object:Gem::Version
|
60
|
-
version: 1.
|
60
|
+
version: 1.26.3
|
61
61
|
- !ruby/object:Gem::Dependency
|
62
62
|
name: minitest
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
65
|
- - "~>"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version: '5.
|
67
|
+
version: '5.16'
|
68
68
|
type: :development
|
69
69
|
prerelease: false
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
|
-
version: '5.
|
74
|
+
version: '5.16'
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
76
|
name: minitest-focus
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
@@ -106,14 +106,14 @@ dependencies:
|
|
106
106
|
requirements:
|
107
107
|
- - ">="
|
108
108
|
- !ruby/object:Gem::Version
|
109
|
-
version: '
|
109
|
+
version: '13.0'
|
110
110
|
type: :development
|
111
111
|
prerelease: false
|
112
112
|
version_requirements: !ruby/object:Gem::Requirement
|
113
113
|
requirements:
|
114
114
|
- - ">="
|
115
115
|
- !ruby/object:Gem::Version
|
116
|
-
version: '
|
116
|
+
version: '13.0'
|
117
117
|
- !ruby/object:Gem::Dependency
|
118
118
|
name: redcarpet
|
119
119
|
requirement: !ruby/object:Gem::Requirement
|
@@ -184,6 +184,7 @@ files:
|
|
184
184
|
- proto_docs/google/api/auth.rb
|
185
185
|
- proto_docs/google/api/backend.rb
|
186
186
|
- proto_docs/google/api/billing.rb
|
187
|
+
- proto_docs/google/api/client.rb
|
187
188
|
- proto_docs/google/api/config_change.rb
|
188
189
|
- proto_docs/google/api/context.rb
|
189
190
|
- proto_docs/google/api/control.rb
|
@@ -228,14 +229,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
228
229
|
requirements:
|
229
230
|
- - ">="
|
230
231
|
- !ruby/object:Gem::Version
|
231
|
-
version: '2.
|
232
|
+
version: '2.6'
|
232
233
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
233
234
|
requirements:
|
234
235
|
- - ">="
|
235
236
|
- !ruby/object:Gem::Version
|
236
237
|
version: '0'
|
237
238
|
requirements: []
|
238
|
-
rubygems_version: 3.
|
239
|
+
rubygems_version: 3.4.2
|
239
240
|
signing_key:
|
240
241
|
specification_version: 4
|
241
242
|
summary: API Client library for the Service Management V1 API
|