google-cloud-automl-v1beta1 0.11.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +30 -20
- data/lib/google/cloud/automl/v1beta1/automl/client.rb +92 -49
- data/lib/google/cloud/automl/v1beta1/automl/operations.rb +25 -20
- data/lib/google/cloud/automl/v1beta1/automl/rest/client.rb +92 -49
- data/lib/google/cloud/automl/v1beta1/automl/rest/operations.rb +65 -50
- data/lib/google/cloud/automl/v1beta1/automl/rest/service_stub.rb +206 -146
- data/lib/google/cloud/automl/v1beta1/prediction_service/client.rb +35 -5
- data/lib/google/cloud/automl/v1beta1/prediction_service/operations.rb +25 -20
- data/lib/google/cloud/automl/v1beta1/prediction_service/rest/client.rb +35 -5
- data/lib/google/cloud/automl/v1beta1/prediction_service/rest/operations.rb +65 -50
- data/lib/google/cloud/automl/v1beta1/prediction_service/rest/service_stub.rb +30 -14
- data/lib/google/cloud/automl/v1beta1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +74 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/longrunning/operations.rb +19 -14
- metadata +5 -5
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module Rest
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
API_VERSION = ""
|
31
|
+
|
29
32
|
# @private
|
30
33
|
DEFAULT_ENDPOINT_TEMPLATE = "automl.$UNIVERSE_DOMAIN$"
|
31
34
|
|
@@ -112,14 +115,6 @@ module Google
|
|
112
115
|
# Lists operations that match the specified filter in the request. If the
|
113
116
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
114
117
|
#
|
115
|
-
# NOTE: the `name` binding allows API services to override the binding
|
116
|
-
# to use different resource name schemes, such as `users/*/operations`. To
|
117
|
-
# override the binding, API services can add a binding such as
|
118
|
-
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
119
|
-
# For backwards compatibility, the default name includes the operations
|
120
|
-
# collection id, however overriding users must ensure the name binding
|
121
|
-
# is the parent resource, without the operations collection id.
|
122
|
-
#
|
123
118
|
# @overload list_operations(request, options = nil)
|
124
119
|
# Pass arguments to `list_operations` via a request object, either of type
|
125
120
|
# {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
|
@@ -181,12 +176,13 @@ module Google
|
|
181
176
|
# Customize the options with defaults
|
182
177
|
call_metadata = @config.rpcs.list_operations.metadata.to_h
|
183
178
|
|
184
|
-
# Set x-goog-api-client
|
179
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
185
180
|
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
186
181
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
187
182
|
gapic_version: ::Google::Cloud::AutoML::V1beta1::VERSION,
|
188
183
|
transports_version_send: [:rest]
|
189
184
|
|
185
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
190
186
|
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
191
187
|
|
192
188
|
options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
|
@@ -200,7 +196,7 @@ module Google
|
|
200
196
|
@operations_stub.list_operations request, options do |result, operation|
|
201
197
|
result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
|
202
198
|
yield result, operation if block_given?
|
203
|
-
|
199
|
+
throw :response, result
|
204
200
|
end
|
205
201
|
rescue ::Gapic::Rest::Error => e
|
206
202
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -269,12 +265,13 @@ module Google
|
|
269
265
|
# Customize the options with defaults
|
270
266
|
call_metadata = @config.rpcs.get_operation.metadata.to_h
|
271
267
|
|
272
|
-
# Set x-goog-api-client
|
268
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
273
269
|
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
274
270
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
275
271
|
gapic_version: ::Google::Cloud::AutoML::V1beta1::VERSION,
|
276
272
|
transports_version_send: [:rest]
|
277
273
|
|
274
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
278
275
|
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
279
276
|
|
280
277
|
options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
|
@@ -288,7 +285,7 @@ module Google
|
|
288
285
|
@operations_stub.get_operation request, options do |result, operation|
|
289
286
|
result = ::Gapic::Operation.new result, @operations_client, options: options
|
290
287
|
yield result, operation if block_given?
|
291
|
-
|
288
|
+
throw :response, result
|
292
289
|
end
|
293
290
|
rescue ::Gapic::Rest::Error => e
|
294
291
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -351,12 +348,13 @@ module Google
|
|
351
348
|
# Customize the options with defaults
|
352
349
|
call_metadata = @config.rpcs.delete_operation.metadata.to_h
|
353
350
|
|
354
|
-
# Set x-goog-api-client
|
351
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
355
352
|
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
356
353
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
357
354
|
gapic_version: ::Google::Cloud::AutoML::V1beta1::VERSION,
|
358
355
|
transports_version_send: [:rest]
|
359
356
|
|
357
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
360
358
|
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
361
359
|
|
362
360
|
options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
|
@@ -369,7 +367,6 @@ module Google
|
|
369
367
|
|
370
368
|
@operations_stub.delete_operation request, options do |result, operation|
|
371
369
|
yield result, operation if block_given?
|
372
|
-
return result
|
373
370
|
end
|
374
371
|
rescue ::Gapic::Rest::Error => e
|
375
372
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -384,8 +381,9 @@ module Google
|
|
384
381
|
# other methods to check whether the cancellation succeeded or whether the
|
385
382
|
# operation completed despite cancellation. On successful cancellation,
|
386
383
|
# the operation is not deleted; instead, it becomes an operation with
|
387
|
-
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
388
|
-
# corresponding to
|
384
|
+
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
385
|
+
# {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
|
386
|
+
# `Code.CANCELLED`.
|
389
387
|
#
|
390
388
|
# @overload cancel_operation(request, options = nil)
|
391
389
|
# Pass arguments to `cancel_operation` via a request object, either of type
|
@@ -438,12 +436,13 @@ module Google
|
|
438
436
|
# Customize the options with defaults
|
439
437
|
call_metadata = @config.rpcs.cancel_operation.metadata.to_h
|
440
438
|
|
441
|
-
# Set x-goog-api-client
|
439
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
442
440
|
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
443
441
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
444
442
|
gapic_version: ::Google::Cloud::AutoML::V1beta1::VERSION,
|
445
443
|
transports_version_send: [:rest]
|
446
444
|
|
445
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
447
446
|
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
448
447
|
|
449
448
|
options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
|
@@ -456,7 +455,6 @@ module Google
|
|
456
455
|
|
457
456
|
@operations_stub.cancel_operation request, options do |result, operation|
|
458
457
|
yield result, operation if block_given?
|
459
|
-
return result
|
460
458
|
end
|
461
459
|
rescue ::Gapic::Rest::Error => e
|
462
460
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -535,12 +533,13 @@ module Google
|
|
535
533
|
# Customize the options with defaults
|
536
534
|
call_metadata = @config.rpcs.wait_operation.metadata.to_h
|
537
535
|
|
538
|
-
# Set x-goog-api-client
|
536
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
539
537
|
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
540
538
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
541
539
|
gapic_version: ::Google::Cloud::AutoML::V1beta1::VERSION,
|
542
540
|
transports_version_send: [:rest]
|
543
541
|
|
542
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
544
543
|
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
545
544
|
|
546
545
|
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
@@ -554,7 +553,7 @@ module Google
|
|
554
553
|
@operations_stub.wait_operation request, options do |result, operation|
|
555
554
|
result = ::Gapic::Operation.new result, @operations_client, options: options
|
556
555
|
yield result, operation if block_given?
|
557
|
-
|
556
|
+
throw :response, result
|
558
557
|
end
|
559
558
|
rescue ::Gapic::Rest::Error => e
|
560
559
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -634,6 +633,11 @@ module Google
|
|
634
633
|
# default endpoint URL. The default value of nil uses the environment
|
635
634
|
# universe (usually the default "googleapis.com" universe).
|
636
635
|
# @return [::String,nil]
|
636
|
+
# @!attribute [rw] logger
|
637
|
+
# A custom logger to use for request/response debug logging, or the value
|
638
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
639
|
+
# explicitly disable logging.
|
640
|
+
# @return [::Logger,:default,nil]
|
637
641
|
#
|
638
642
|
class Configuration
|
639
643
|
extend ::Gapic::Config
|
@@ -655,6 +659,7 @@ module Google
|
|
655
659
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
656
660
|
config_attr :quota_project, nil, ::String, nil
|
657
661
|
config_attr :universe_domain, nil, ::String, nil
|
662
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
658
663
|
|
659
664
|
# @private
|
660
665
|
def initialize parent_config = nil
|
@@ -781,16 +786,18 @@ module Google
|
|
781
786
|
|
782
787
|
response = @client_stub.make_http_request(
|
783
788
|
verb,
|
784
|
-
uri:
|
785
|
-
body:
|
786
|
-
params:
|
789
|
+
uri: uri,
|
790
|
+
body: body || "",
|
791
|
+
params: query_string_params,
|
792
|
+
method_name: "list_operations",
|
787
793
|
options: options
|
788
794
|
)
|
789
795
|
operation = ::Gapic::Rest::TransportOperation.new response
|
790
796
|
result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
|
791
|
-
|
792
|
-
|
793
|
-
|
797
|
+
catch :response do
|
798
|
+
yield result, operation if block_given?
|
799
|
+
result
|
800
|
+
end
|
794
801
|
end
|
795
802
|
|
796
803
|
##
|
@@ -819,16 +826,18 @@ module Google
|
|
819
826
|
|
820
827
|
response = @client_stub.make_http_request(
|
821
828
|
verb,
|
822
|
-
uri:
|
823
|
-
body:
|
824
|
-
params:
|
829
|
+
uri: uri,
|
830
|
+
body: body || "",
|
831
|
+
params: query_string_params,
|
832
|
+
method_name: "get_operation",
|
825
833
|
options: options
|
826
834
|
)
|
827
835
|
operation = ::Gapic::Rest::TransportOperation.new response
|
828
836
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
829
|
-
|
830
|
-
|
831
|
-
|
837
|
+
catch :response do
|
838
|
+
yield result, operation if block_given?
|
839
|
+
result
|
840
|
+
end
|
832
841
|
end
|
833
842
|
|
834
843
|
##
|
@@ -857,16 +866,18 @@ module Google
|
|
857
866
|
|
858
867
|
response = @client_stub.make_http_request(
|
859
868
|
verb,
|
860
|
-
uri:
|
861
|
-
body:
|
862
|
-
params:
|
869
|
+
uri: uri,
|
870
|
+
body: body || "",
|
871
|
+
params: query_string_params,
|
872
|
+
method_name: "delete_operation",
|
863
873
|
options: options
|
864
874
|
)
|
865
875
|
operation = ::Gapic::Rest::TransportOperation.new response
|
866
876
|
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
867
|
-
|
868
|
-
|
869
|
-
|
877
|
+
catch :response do
|
878
|
+
yield result, operation if block_given?
|
879
|
+
result
|
880
|
+
end
|
870
881
|
end
|
871
882
|
|
872
883
|
##
|
@@ -895,16 +906,18 @@ module Google
|
|
895
906
|
|
896
907
|
response = @client_stub.make_http_request(
|
897
908
|
verb,
|
898
|
-
uri:
|
899
|
-
body:
|
900
|
-
params:
|
909
|
+
uri: uri,
|
910
|
+
body: body || "",
|
911
|
+
params: query_string_params,
|
912
|
+
method_name: "cancel_operation",
|
901
913
|
options: options
|
902
914
|
)
|
903
915
|
operation = ::Gapic::Rest::TransportOperation.new response
|
904
916
|
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
905
|
-
|
906
|
-
|
907
|
-
|
917
|
+
catch :response do
|
918
|
+
yield result, operation if block_given?
|
919
|
+
result
|
920
|
+
end
|
908
921
|
end
|
909
922
|
|
910
923
|
##
|
@@ -933,16 +946,18 @@ module Google
|
|
933
946
|
|
934
947
|
response = @client_stub.make_http_request(
|
935
948
|
verb,
|
936
|
-
uri:
|
937
|
-
body:
|
938
|
-
params:
|
949
|
+
uri: uri,
|
950
|
+
body: body || "",
|
951
|
+
params: query_string_params,
|
952
|
+
method_name: "wait_operation",
|
939
953
|
options: options
|
940
954
|
)
|
941
955
|
operation = ::Gapic::Rest::TransportOperation.new response
|
942
956
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
943
|
-
|
944
|
-
|
945
|
-
|
957
|
+
catch :response do
|
958
|
+
yield result, operation if block_given?
|
959
|
+
result
|
960
|
+
end
|
946
961
|
end
|
947
962
|
|
948
963
|
##
|
@@ -30,7 +30,8 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
|
33
|
+
# @private
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
|
34
35
|
# These require statements are intentionally placed here to initialize
|
35
36
|
# the REST modules only when it's required.
|
36
37
|
require "gapic/rest"
|
@@ -40,7 +41,9 @@ module Google
|
|
40
41
|
universe_domain: universe_domain,
|
41
42
|
credentials: credentials,
|
42
43
|
numeric_enums: true,
|
43
|
-
|
44
|
+
service_name: self.class,
|
45
|
+
raise_faraday_errors: false,
|
46
|
+
logger: logger
|
44
47
|
end
|
45
48
|
|
46
49
|
##
|
@@ -61,6 +64,15 @@ module Google
|
|
61
64
|
@client_stub.endpoint
|
62
65
|
end
|
63
66
|
|
67
|
+
##
|
68
|
+
# The logger used for request/response debug logging.
|
69
|
+
#
|
70
|
+
# @return [Logger]
|
71
|
+
#
|
72
|
+
def logger stub: false
|
73
|
+
stub ? @client_stub.stub_logger : @client_stub.logger
|
74
|
+
end
|
75
|
+
|
64
76
|
##
|
65
77
|
# Baseline implementation for the predict REST call
|
66
78
|
#
|
@@ -87,16 +99,18 @@ module Google
|
|
87
99
|
|
88
100
|
response = @client_stub.make_http_request(
|
89
101
|
verb,
|
90
|
-
uri:
|
91
|
-
body:
|
92
|
-
params:
|
102
|
+
uri: uri,
|
103
|
+
body: body || "",
|
104
|
+
params: query_string_params,
|
105
|
+
method_name: "predict",
|
93
106
|
options: options
|
94
107
|
)
|
95
108
|
operation = ::Gapic::Rest::TransportOperation.new response
|
96
109
|
result = ::Google::Cloud::AutoML::V1beta1::PredictResponse.decode_json response.body, ignore_unknown_fields: true
|
97
|
-
|
98
|
-
|
99
|
-
|
110
|
+
catch :response do
|
111
|
+
yield result, operation if block_given?
|
112
|
+
result
|
113
|
+
end
|
100
114
|
end
|
101
115
|
|
102
116
|
##
|
@@ -125,16 +139,18 @@ module Google
|
|
125
139
|
|
126
140
|
response = @client_stub.make_http_request(
|
127
141
|
verb,
|
128
|
-
uri:
|
129
|
-
body:
|
130
|
-
params:
|
142
|
+
uri: uri,
|
143
|
+
body: body || "",
|
144
|
+
params: query_string_params,
|
145
|
+
method_name: "batch_predict",
|
131
146
|
options: options
|
132
147
|
)
|
133
148
|
operation = ::Gapic::Rest::TransportOperation.new response
|
134
149
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
135
|
-
|
136
|
-
|
137
|
-
|
150
|
+
catch :response do
|
151
|
+
yield result, operation if block_given?
|
152
|
+
result
|
153
|
+
end
|
138
154
|
end
|
139
155
|
|
140
156
|
##
|
@@ -28,6 +28,9 @@ module Google
|
|
28
28
|
# @!attribute [rw] destinations
|
29
29
|
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
30
30
|
# The destination where API teams want this client library to be published.
|
31
|
+
# @!attribute [rw] selective_gapic_generation
|
32
|
+
# @return [::Google::Api::SelectiveGapicGeneration]
|
33
|
+
# Configuration for which RPCs should be generated in the GAPIC client.
|
31
34
|
class CommonLanguageSettings
|
32
35
|
include ::Google::Protobuf::MessageExts
|
33
36
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -118,6 +121,10 @@ module Google
|
|
118
121
|
# @return [::String]
|
119
122
|
# Optional link to proto reference documentation. Example:
|
120
123
|
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
124
|
+
# @!attribute [rw] rest_reference_documentation_uri
|
125
|
+
# @return [::String]
|
126
|
+
# Optional link to REST reference documentation. Example:
|
127
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rest
|
121
128
|
class Publishing
|
122
129
|
include ::Google::Protobuf::MessageExts
|
123
130
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -192,9 +199,32 @@ module Google
|
|
192
199
|
# @!attribute [rw] common
|
193
200
|
# @return [::Google::Api::CommonLanguageSettings]
|
194
201
|
# Some settings.
|
202
|
+
# @!attribute [rw] experimental_features
|
203
|
+
# @return [::Google::Api::PythonSettings::ExperimentalFeatures]
|
204
|
+
# Experimental features to be included during client library generation.
|
195
205
|
class PythonSettings
|
196
206
|
include ::Google::Protobuf::MessageExts
|
197
207
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
208
|
+
|
209
|
+
# Experimental features to be included during client library generation.
|
210
|
+
# These fields will be deprecated once the feature graduates and is enabled
|
211
|
+
# by default.
|
212
|
+
# @!attribute [rw] rest_async_io_enabled
|
213
|
+
# @return [::Boolean]
|
214
|
+
# Enables generation of asynchronous REST clients if `rest` transport is
|
215
|
+
# enabled. By default, asynchronous REST clients will not be generated.
|
216
|
+
# This feature will be enabled by default 1 month after launching the
|
217
|
+
# feature in preview packages.
|
218
|
+
# @!attribute [rw] protobuf_pythonic_types_enabled
|
219
|
+
# @return [::Boolean]
|
220
|
+
# Enables generation of protobuf code using new types that are more
|
221
|
+
# Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
222
|
+
# enabled by default 1 month after launching the feature in preview
|
223
|
+
# packages.
|
224
|
+
class ExperimentalFeatures
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
198
228
|
end
|
199
229
|
|
200
230
|
# Settings for Node client libraries.
|
@@ -276,9 +306,28 @@ module Google
|
|
276
306
|
# @!attribute [rw] common
|
277
307
|
# @return [::Google::Api::CommonLanguageSettings]
|
278
308
|
# Some settings.
|
309
|
+
# @!attribute [rw] renamed_services
|
310
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
311
|
+
# Map of service names to renamed services. Keys are the package relative
|
312
|
+
# service names and values are the name to be used for the service client
|
313
|
+
# and call options.
|
314
|
+
#
|
315
|
+
# publishing:
|
316
|
+
# go_settings:
|
317
|
+
# renamed_services:
|
318
|
+
# Publisher: TopicAdmin
|
279
319
|
class GoSettings
|
280
320
|
include ::Google::Protobuf::MessageExts
|
281
321
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
322
|
+
|
323
|
+
# @!attribute [rw] key
|
324
|
+
# @return [::String]
|
325
|
+
# @!attribute [rw] value
|
326
|
+
# @return [::String]
|
327
|
+
class RenamedServicesEntry
|
328
|
+
include ::Google::Protobuf::MessageExts
|
329
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
|
+
end
|
282
331
|
end
|
283
332
|
|
284
333
|
# Describes the generator configuration for a method.
|
@@ -286,6 +335,13 @@ module Google
|
|
286
335
|
# @return [::String]
|
287
336
|
# The fully qualified name of the method, for which the options below apply.
|
288
337
|
# This is used to find the method to apply the options.
|
338
|
+
#
|
339
|
+
# Example:
|
340
|
+
#
|
341
|
+
# publishing:
|
342
|
+
# method_settings:
|
343
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
344
|
+
# # method settings for CreateFolder...
|
289
345
|
# @!attribute [rw] long_running
|
290
346
|
# @return [::Google::Api::MethodSettings::LongRunning]
|
291
347
|
# Describes settings to use for long-running operations when generating
|
@@ -294,17 +350,14 @@ module Google
|
|
294
350
|
#
|
295
351
|
# Example of a YAML configuration::
|
296
352
|
#
|
297
|
-
#
|
298
|
-
#
|
353
|
+
# publishing:
|
354
|
+
# method_settings:
|
299
355
|
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
300
356
|
# long_running:
|
301
|
-
# initial_poll_delay:
|
302
|
-
# seconds: 60 # 1 minute
|
357
|
+
# initial_poll_delay: 60s # 1 minute
|
303
358
|
# poll_delay_multiplier: 1.5
|
304
|
-
# max_poll_delay:
|
305
|
-
#
|
306
|
-
# total_poll_timeout:
|
307
|
-
# seconds: 54000 # 90 minutes
|
359
|
+
# max_poll_delay: 360s # 6 minutes
|
360
|
+
# total_poll_timeout: 54000s # 90 minutes
|
308
361
|
# @!attribute [rw] auto_populated_fields
|
309
362
|
# @return [::Array<::String>]
|
310
363
|
# List of top-level fields of the request message, that should be
|
@@ -313,8 +366,8 @@ module Google
|
|
313
366
|
#
|
314
367
|
# Example of a YAML configuration:
|
315
368
|
#
|
316
|
-
#
|
317
|
-
#
|
369
|
+
# publishing:
|
370
|
+
# method_settings:
|
318
371
|
# - selector: google.example.v1.ExampleService.CreateExample
|
319
372
|
# auto_populated_fields:
|
320
373
|
# - request_id
|
@@ -350,6 +403,17 @@ module Google
|
|
350
403
|
end
|
351
404
|
end
|
352
405
|
|
406
|
+
# This message is used to configure the generation of a subset of the RPCs in
|
407
|
+
# a service for client libraries.
|
408
|
+
# @!attribute [rw] methods
|
409
|
+
# @return [::Array<::String>]
|
410
|
+
# An allowlist of the fully qualified names of RPCs that should be included
|
411
|
+
# on public client surfaces.
|
412
|
+
class SelectiveGapicGeneration
|
413
|
+
include ::Google::Protobuf::MessageExts
|
414
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
415
|
+
end
|
416
|
+
|
353
417
|
# The organization for which the client libraries are being published.
|
354
418
|
# Affects the url where generated docs are published, etc.
|
355
419
|
module ClientLibraryOrganization
|
@@ -124,8 +124,13 @@ module Google
|
|
124
124
|
# @return [::String]
|
125
125
|
# The plural name used in the resource name and permission names, such as
|
126
126
|
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
127
|
-
# name of 'cloudresourcemanager.googleapis.com/projects.get'.
|
128
|
-
#
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
|
128
|
+
# to this is for Nested Collections that have stuttering names, as defined
|
129
|
+
# in [AIP-122](https://google.aip.dev/122#nested-collections), where the
|
130
|
+
# collection ID in the resource name pattern does not necessarily directly
|
131
|
+
# match the `plural` value.
|
132
|
+
#
|
133
|
+
# It is the same concept of the `plural` field in k8s CRD spec
|
129
134
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
130
135
|
#
|
131
136
|
# Note: The plural form is required even for singleton resources. See
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# The error result of the operation in case of failure or cancellation.
|
43
43
|
# @!attribute [rw] response
|
44
44
|
# @return [::Google::Protobuf::Any]
|
45
|
-
# The normal response of the operation
|
45
|
+
# The normal, successful response of the operation. If the original
|
46
46
|
# method returns no data on success, such as `Delete`, the response is
|
47
47
|
# `google.protobuf.Empty`. If the original method is standard
|
48
48
|
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
@@ -55,7 +55,8 @@ module Google
|
|
55
55
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
56
|
end
|
57
57
|
|
58
|
-
# The request message for
|
58
|
+
# The request message for
|
59
|
+
# Operations.GetOperation.
|
59
60
|
# @!attribute [rw] name
|
60
61
|
# @return [::String]
|
61
62
|
# The name of the operation resource.
|
@@ -64,7 +65,8 @@ module Google
|
|
64
65
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
66
|
end
|
66
67
|
|
67
|
-
# The request message for
|
68
|
+
# The request message for
|
69
|
+
# Operations.ListOperations.
|
68
70
|
# @!attribute [rw] name
|
69
71
|
# @return [::String]
|
70
72
|
# The name of the operation's parent resource.
|
@@ -82,7 +84,8 @@ module Google
|
|
82
84
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
85
|
end
|
84
86
|
|
85
|
-
# The response message for
|
87
|
+
# The response message for
|
88
|
+
# Operations.ListOperations.
|
86
89
|
# @!attribute [rw] operations
|
87
90
|
# @return [::Array<::Google::Longrunning::Operation>]
|
88
91
|
# A list of operations that matches the specified filter in the request.
|
@@ -94,7 +97,8 @@ module Google
|
|
94
97
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
98
|
end
|
96
99
|
|
97
|
-
# The request message for
|
100
|
+
# The request message for
|
101
|
+
# Operations.CancelOperation.
|
98
102
|
# @!attribute [rw] name
|
99
103
|
# @return [::String]
|
100
104
|
# The name of the operation resource to be cancelled.
|
@@ -103,7 +107,8 @@ module Google
|
|
103
107
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
108
|
end
|
105
109
|
|
106
|
-
# The request message for
|
110
|
+
# The request message for
|
111
|
+
# Operations.DeleteOperation.
|
107
112
|
# @!attribute [rw] name
|
108
113
|
# @return [::String]
|
109
114
|
# The name of the operation resource to be deleted.
|
@@ -112,7 +117,8 @@ module Google
|
|
112
117
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
118
|
end
|
114
119
|
|
115
|
-
# The request message for
|
120
|
+
# The request message for
|
121
|
+
# Operations.WaitOperation.
|
116
122
|
# @!attribute [rw] name
|
117
123
|
# @return [::String]
|
118
124
|
# The name of the operation resource to wait on.
|
@@ -130,13 +136,12 @@ module Google
|
|
130
136
|
#
|
131
137
|
# Example:
|
132
138
|
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# }
|
139
|
-
# }
|
139
|
+
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
|
140
|
+
# option (google.longrunning.operation_info) = {
|
141
|
+
# response_type: "ExportResponse"
|
142
|
+
# metadata_type: "ExportMetadata"
|
143
|
+
# };
|
144
|
+
# }
|
140
145
|
# @!attribute [rw] response_type
|
141
146
|
# @return [::String]
|
142
147
|
# Required. The message name of the primary return type for this
|