google-cloud-optimization-v1 0.9.2 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +31 -21
- data/lib/google/cloud/optimization/v1/fleet_routing/client.rb +35 -3
- data/lib/google/cloud/optimization/v1/fleet_routing/operations.rb +19 -15
- data/lib/google/cloud/optimization/v1/fleet_routing/rest/client.rb +35 -3
- data/lib/google/cloud/optimization/v1/fleet_routing/rest/operations.rb +50 -38
- data/lib/google/cloud/optimization/v1/fleet_routing/rest/service_stub.rb +30 -14
- data/lib/google/cloud/optimization/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/cloud/optimization/v1/fleet_routing.rb +8 -0
- data/proto_docs/google/longrunning/operations.rb +23 -14
- metadata +6 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 53f425f901f1b9ba39ebe4e368925dacb2f2ac6a0c3fa2b891fe5174a1b3e50a
|
4
|
+
data.tar.gz: 4379902e783202b7f4502bca4fcf601178e58b1f490e8a26a3b2f75a408c42b0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 43d7b9b6ac3b97679377ea8d477f611c05477d82804386611f4f5989290ae277334f18e4f3a1cce59df7c2e16bfdbe43c2e1fa955dadd9124a4eec63b94b6f4b
|
7
|
+
data.tar.gz: aebf21d15fead4370317821d671b785b7037a9245b4dfe6e650eaf6ffd96bbd5ca468a332fcab3c7a850824f4519bbc0871fcf3bdacbe57049e04a280ee57a2f
|
data/README.md
CHANGED
@@ -42,40 +42,50 @@ for class and method documentation.
|
|
42
42
|
See also the [Product Documentation](https://cloud.google.com/optimization)
|
43
43
|
for general usage information.
|
44
44
|
|
45
|
-
##
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
45
|
+
## Debug Logging
|
46
|
+
|
47
|
+
This library comes with opt-in Debug Logging that can help you troubleshoot
|
48
|
+
your application's integration with the API. When logging is activated, key
|
49
|
+
events such as requests and responses, along with data payloads and metadata
|
50
|
+
such as headers and client configuration, are logged to the standard error
|
51
|
+
stream.
|
52
|
+
|
53
|
+
**WARNING:** Client Library Debug Logging includes your data payloads in
|
54
|
+
plaintext, which could include sensitive data such as PII for yourself or your
|
55
|
+
customers, private keys, or other security data that could be compromising if
|
56
|
+
leaked. Always practice good data hygiene with your application logs, and follow
|
57
|
+
the principle of least access. Google also recommends that Client Library Debug
|
58
|
+
Logging be enabled only temporarily during active debugging, and not used
|
59
|
+
permanently in production.
|
60
|
+
|
61
|
+
To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
|
62
|
+
to the value `all`. Alternatively, you can set the value to a comma-delimited
|
63
|
+
list of client library gem names. This will select the default logging behavior,
|
64
|
+
which writes logs to the standard error stream. On a local workstation, this may
|
65
|
+
result in logs appearing on the console. When running on a Google Cloud hosting
|
66
|
+
service such as [Google Cloud Run](https://cloud.google.com/run), this generally
|
67
|
+
results in logs appearing alongside your application logs in the
|
68
|
+
[Google Cloud Logging](https://cloud.google.com/logging/) service.
|
69
|
+
|
70
|
+
You can customize logging by modifying the `logger` configuration when
|
71
|
+
constructing a client object. For example:
|
54
72
|
|
55
73
|
```ruby
|
74
|
+
require "google/cloud/optimization/v1"
|
56
75
|
require "logger"
|
57
76
|
|
58
|
-
|
59
|
-
|
60
|
-
def logger
|
61
|
-
LOGGER
|
62
|
-
end
|
63
|
-
end
|
64
|
-
|
65
|
-
# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
|
66
|
-
module GRPC
|
67
|
-
extend MyLogger
|
77
|
+
client = ::Google::Cloud::Optimization::V1::FleetRouting::Client.new do |config|
|
78
|
+
config.logger = Logger.new "my-app.log"
|
68
79
|
end
|
69
80
|
```
|
70
81
|
|
71
|
-
|
72
82
|
## Google Cloud Samples
|
73
83
|
|
74
84
|
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
75
85
|
|
76
86
|
## Supported Ruby Versions
|
77
87
|
|
78
|
-
This library is supported on Ruby
|
88
|
+
This library is supported on Ruby 3.0+.
|
79
89
|
|
80
90
|
Google provides official support for Ruby versions that are actively supported
|
81
91
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
@@ -188,8 +188,19 @@ module Google
|
|
188
188
|
universe_domain: @config.universe_domain,
|
189
189
|
channel_args: @config.channel_args,
|
190
190
|
interceptors: @config.interceptors,
|
191
|
-
channel_pool_config: @config.channel_pool
|
191
|
+
channel_pool_config: @config.channel_pool,
|
192
|
+
logger: @config.logger
|
192
193
|
)
|
194
|
+
|
195
|
+
@fleet_routing_stub.stub_logger&.info do |entry|
|
196
|
+
entry.set_system_name
|
197
|
+
entry.set_service
|
198
|
+
entry.message = "Created client for #{entry.service}"
|
199
|
+
entry.set_credentials_fields credentials
|
200
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
201
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
202
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
203
|
+
end
|
193
204
|
end
|
194
205
|
|
195
206
|
##
|
@@ -199,6 +210,15 @@ module Google
|
|
199
210
|
#
|
200
211
|
attr_reader :operations_client
|
201
212
|
|
213
|
+
##
|
214
|
+
# The logger used for request/response debug logging.
|
215
|
+
#
|
216
|
+
# @return [Logger]
|
217
|
+
#
|
218
|
+
def logger
|
219
|
+
@fleet_routing_stub.logger
|
220
|
+
end
|
221
|
+
|
202
222
|
# Service calls
|
203
223
|
|
204
224
|
##
|
@@ -481,7 +501,6 @@ module Google
|
|
481
501
|
|
482
502
|
@fleet_routing_stub.call_rpc :optimize_tours, request, options: options do |response, operation|
|
483
503
|
yield response, operation if block_given?
|
484
|
-
return response
|
485
504
|
end
|
486
505
|
rescue ::GRPC::BadStatus => e
|
487
506
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -591,7 +610,7 @@ module Google
|
|
591
610
|
@fleet_routing_stub.call_rpc :batch_optimize_tours, request, options: options do |response, operation|
|
592
611
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
593
612
|
yield response, operation if block_given?
|
594
|
-
|
613
|
+
throw :response, response
|
595
614
|
end
|
596
615
|
rescue ::GRPC::BadStatus => e
|
597
616
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -641,6 +660,13 @@ module Google
|
|
641
660
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
642
661
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
643
662
|
# * (`nil`) indicating no credentials
|
663
|
+
#
|
664
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
665
|
+
# external source for authentication to Google Cloud, you must validate it before
|
666
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
667
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
668
|
+
# For more information, refer to [Validate credential configurations from external
|
669
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
644
670
|
# @return [::Object]
|
645
671
|
# @!attribute [rw] scope
|
646
672
|
# The OAuth scopes
|
@@ -680,6 +706,11 @@ module Google
|
|
680
706
|
# default endpoint URL. The default value of nil uses the environment
|
681
707
|
# universe (usually the default "googleapis.com" universe).
|
682
708
|
# @return [::String,nil]
|
709
|
+
# @!attribute [rw] logger
|
710
|
+
# A custom logger to use for request/response debug logging, or the value
|
711
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
712
|
+
# explicitly disable logging.
|
713
|
+
# @return [::Logger,:default,nil]
|
683
714
|
#
|
684
715
|
class Configuration
|
685
716
|
extend ::Gapic::Config
|
@@ -704,6 +735,7 @@ module Google
|
|
704
735
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
705
736
|
config_attr :quota_project, nil, ::String, nil
|
706
737
|
config_attr :universe_domain, nil, ::String, nil
|
738
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
707
739
|
|
708
740
|
# @private
|
709
741
|
def initialize parent_config = nil
|
@@ -124,14 +124,6 @@ module Google
|
|
124
124
|
# Lists operations that match the specified filter in the request. If the
|
125
125
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
126
126
|
#
|
127
|
-
# NOTE: the `name` binding allows API services to override the binding
|
128
|
-
# to use different resource name schemes, such as `users/*/operations`. To
|
129
|
-
# override the binding, API services can add a binding such as
|
130
|
-
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
131
|
-
# For backwards compatibility, the default name includes the operations
|
132
|
-
# collection id, however overriding users must ensure the name binding
|
133
|
-
# is the parent resource, without the operations collection id.
|
134
|
-
#
|
135
127
|
# @overload list_operations(request, options = nil)
|
136
128
|
# Pass arguments to `list_operations` via a request object, either of type
|
137
129
|
# {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
|
@@ -221,7 +213,7 @@ module Google
|
|
221
213
|
wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
|
222
214
|
response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
|
223
215
|
yield response, operation if block_given?
|
224
|
-
|
216
|
+
throw :response, response
|
225
217
|
end
|
226
218
|
rescue ::GRPC::BadStatus => e
|
227
219
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -317,7 +309,7 @@ module Google
|
|
317
309
|
@operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
|
318
310
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
319
311
|
yield response, operation if block_given?
|
320
|
-
|
312
|
+
throw :response, response
|
321
313
|
end
|
322
314
|
rescue ::GRPC::BadStatus => e
|
323
315
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -406,7 +398,6 @@ module Google
|
|
406
398
|
|
407
399
|
@operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
|
408
400
|
yield response, operation if block_given?
|
409
|
-
return response
|
410
401
|
end
|
411
402
|
rescue ::GRPC::BadStatus => e
|
412
403
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -421,8 +412,9 @@ module Google
|
|
421
412
|
# other methods to check whether the cancellation succeeded or whether the
|
422
413
|
# operation completed despite cancellation. On successful cancellation,
|
423
414
|
# the operation is not deleted; instead, it becomes an operation with
|
424
|
-
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
425
|
-
# corresponding to
|
415
|
+
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
416
|
+
# {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
|
417
|
+
# `Code.CANCELLED`.
|
426
418
|
#
|
427
419
|
# @overload cancel_operation(request, options = nil)
|
428
420
|
# Pass arguments to `cancel_operation` via a request object, either of type
|
@@ -501,7 +493,6 @@ module Google
|
|
501
493
|
|
502
494
|
@operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
|
503
495
|
yield response, operation if block_given?
|
504
|
-
return response
|
505
496
|
end
|
506
497
|
rescue ::GRPC::BadStatus => e
|
507
498
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -599,7 +590,7 @@ module Google
|
|
599
590
|
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
600
591
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
601
592
|
yield response, operation if block_given?
|
602
|
-
|
593
|
+
throw :response, response
|
603
594
|
end
|
604
595
|
rescue ::GRPC::BadStatus => e
|
605
596
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -649,6 +640,13 @@ module Google
|
|
649
640
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
650
641
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
651
642
|
# * (`nil`) indicating no credentials
|
643
|
+
#
|
644
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
645
|
+
# external source for authentication to Google Cloud, you must validate it before
|
646
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
647
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
648
|
+
# For more information, refer to [Validate credential configurations from external
|
649
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
652
650
|
# @return [::Object]
|
653
651
|
# @!attribute [rw] scope
|
654
652
|
# The OAuth scopes
|
@@ -688,6 +686,11 @@ module Google
|
|
688
686
|
# default endpoint URL. The default value of nil uses the environment
|
689
687
|
# universe (usually the default "googleapis.com" universe).
|
690
688
|
# @return [::String,nil]
|
689
|
+
# @!attribute [rw] logger
|
690
|
+
# A custom logger to use for request/response debug logging, or the value
|
691
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
692
|
+
# explicitly disable logging.
|
693
|
+
# @return [::Logger,:default,nil]
|
691
694
|
#
|
692
695
|
class Configuration
|
693
696
|
extend ::Gapic::Config
|
@@ -712,6 +715,7 @@ module Google
|
|
712
715
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
713
716
|
config_attr :quota_project, nil, ::String, nil
|
714
717
|
config_attr :universe_domain, nil, ::String, nil
|
718
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
715
719
|
|
716
720
|
# @private
|
717
721
|
def initialize parent_config = nil
|
@@ -181,8 +181,19 @@ module Google
|
|
181
181
|
endpoint: @config.endpoint,
|
182
182
|
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
183
183
|
universe_domain: @config.universe_domain,
|
184
|
-
credentials: credentials
|
184
|
+
credentials: credentials,
|
185
|
+
logger: @config.logger
|
185
186
|
)
|
187
|
+
|
188
|
+
@fleet_routing_stub.logger(stub: true)&.info do |entry|
|
189
|
+
entry.set_system_name
|
190
|
+
entry.set_service
|
191
|
+
entry.message = "Created client for #{entry.service}"
|
192
|
+
entry.set_credentials_fields credentials
|
193
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
194
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
195
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
196
|
+
end
|
186
197
|
end
|
187
198
|
|
188
199
|
##
|
@@ -192,6 +203,15 @@ module Google
|
|
192
203
|
#
|
193
204
|
attr_reader :operations_client
|
194
205
|
|
206
|
+
##
|
207
|
+
# The logger used for request/response debug logging.
|
208
|
+
#
|
209
|
+
# @return [Logger]
|
210
|
+
#
|
211
|
+
def logger
|
212
|
+
@fleet_routing_stub.logger
|
213
|
+
end
|
214
|
+
|
195
215
|
# Service calls
|
196
216
|
|
197
217
|
##
|
@@ -467,7 +487,6 @@ module Google
|
|
467
487
|
|
468
488
|
@fleet_routing_stub.optimize_tours request, options do |result, operation|
|
469
489
|
yield result, operation if block_given?
|
470
|
-
return result
|
471
490
|
end
|
472
491
|
rescue ::Gapic::Rest::Error => e
|
473
492
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -570,7 +589,7 @@ module Google
|
|
570
589
|
@fleet_routing_stub.batch_optimize_tours request, options do |result, operation|
|
571
590
|
result = ::Gapic::Operation.new result, @operations_client, options: options
|
572
591
|
yield result, operation if block_given?
|
573
|
-
|
592
|
+
throw :response, result
|
574
593
|
end
|
575
594
|
rescue ::Gapic::Rest::Error => e
|
576
595
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -618,6 +637,13 @@ module Google
|
|
618
637
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
619
638
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
620
639
|
# * (`nil`) indicating no credentials
|
640
|
+
#
|
641
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
642
|
+
# external source for authentication to Google Cloud, you must validate it before
|
643
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
644
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
645
|
+
# For more information, refer to [Validate credential configurations from external
|
646
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
621
647
|
# @return [::Object]
|
622
648
|
# @!attribute [rw] scope
|
623
649
|
# The OAuth scopes
|
@@ -650,6 +676,11 @@ module Google
|
|
650
676
|
# default endpoint URL. The default value of nil uses the environment
|
651
677
|
# universe (usually the default "googleapis.com" universe).
|
652
678
|
# @return [::String,nil]
|
679
|
+
# @!attribute [rw] logger
|
680
|
+
# A custom logger to use for request/response debug logging, or the value
|
681
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
682
|
+
# explicitly disable logging.
|
683
|
+
# @return [::Logger,:default,nil]
|
653
684
|
#
|
654
685
|
class Configuration
|
655
686
|
extend ::Gapic::Config
|
@@ -671,6 +702,7 @@ module Google
|
|
671
702
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
672
703
|
config_attr :quota_project, nil, ::String, nil
|
673
704
|
config_attr :universe_domain, nil, ::String, nil
|
705
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
674
706
|
|
675
707
|
# @private
|
676
708
|
def initialize parent_config = nil
|
@@ -115,14 +115,6 @@ module Google
|
|
115
115
|
# Lists operations that match the specified filter in the request. If the
|
116
116
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
117
117
|
#
|
118
|
-
# NOTE: the `name` binding allows API services to override the binding
|
119
|
-
# to use different resource name schemes, such as `users/*/operations`. To
|
120
|
-
# override the binding, API services can add a binding such as
|
121
|
-
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
122
|
-
# For backwards compatibility, the default name includes the operations
|
123
|
-
# collection id, however overriding users must ensure the name binding
|
124
|
-
# is the parent resource, without the operations collection id.
|
125
|
-
#
|
126
118
|
# @overload list_operations(request, options = nil)
|
127
119
|
# Pass arguments to `list_operations` via a request object, either of type
|
128
120
|
# {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
|
@@ -204,7 +196,7 @@ module Google
|
|
204
196
|
@operations_stub.list_operations request, options do |result, operation|
|
205
197
|
result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
|
206
198
|
yield result, operation if block_given?
|
207
|
-
|
199
|
+
throw :response, result
|
208
200
|
end
|
209
201
|
rescue ::Gapic::Rest::Error => e
|
210
202
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -293,7 +285,7 @@ module Google
|
|
293
285
|
@operations_stub.get_operation request, options do |result, operation|
|
294
286
|
result = ::Gapic::Operation.new result, @operations_client, options: options
|
295
287
|
yield result, operation if block_given?
|
296
|
-
|
288
|
+
throw :response, result
|
297
289
|
end
|
298
290
|
rescue ::Gapic::Rest::Error => e
|
299
291
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -375,7 +367,6 @@ module Google
|
|
375
367
|
|
376
368
|
@operations_stub.delete_operation request, options do |result, operation|
|
377
369
|
yield result, operation if block_given?
|
378
|
-
return result
|
379
370
|
end
|
380
371
|
rescue ::Gapic::Rest::Error => e
|
381
372
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -390,8 +381,9 @@ module Google
|
|
390
381
|
# other methods to check whether the cancellation succeeded or whether the
|
391
382
|
# operation completed despite cancellation. On successful cancellation,
|
392
383
|
# the operation is not deleted; instead, it becomes an operation with
|
393
|
-
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
394
|
-
# 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`.
|
395
387
|
#
|
396
388
|
# @overload cancel_operation(request, options = nil)
|
397
389
|
# Pass arguments to `cancel_operation` via a request object, either of type
|
@@ -463,7 +455,6 @@ module Google
|
|
463
455
|
|
464
456
|
@operations_stub.cancel_operation request, options do |result, operation|
|
465
457
|
yield result, operation if block_given?
|
466
|
-
return result
|
467
458
|
end
|
468
459
|
rescue ::Gapic::Rest::Error => e
|
469
460
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -511,6 +502,13 @@ module Google
|
|
511
502
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
512
503
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
513
504
|
# * (`nil`) indicating no credentials
|
505
|
+
#
|
506
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
507
|
+
# external source for authentication to Google Cloud, you must validate it before
|
508
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
509
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
510
|
+
# For more information, refer to [Validate credential configurations from external
|
511
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
514
512
|
# @return [::Object]
|
515
513
|
# @!attribute [rw] scope
|
516
514
|
# The OAuth scopes
|
@@ -543,6 +541,11 @@ module Google
|
|
543
541
|
# default endpoint URL. The default value of nil uses the environment
|
544
542
|
# universe (usually the default "googleapis.com" universe).
|
545
543
|
# @return [::String,nil]
|
544
|
+
# @!attribute [rw] logger
|
545
|
+
# A custom logger to use for request/response debug logging, or the value
|
546
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
547
|
+
# explicitly disable logging.
|
548
|
+
# @return [::Logger,:default,nil]
|
546
549
|
#
|
547
550
|
class Configuration
|
548
551
|
extend ::Gapic::Config
|
@@ -564,6 +567,7 @@ module Google
|
|
564
567
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
565
568
|
config_attr :quota_project, nil, ::String, nil
|
566
569
|
config_attr :universe_domain, nil, ::String, nil
|
570
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
567
571
|
|
568
572
|
# @private
|
569
573
|
def initialize parent_config = nil
|
@@ -683,16 +687,18 @@ module Google
|
|
683
687
|
|
684
688
|
response = @client_stub.make_http_request(
|
685
689
|
verb,
|
686
|
-
uri:
|
687
|
-
body:
|
688
|
-
params:
|
690
|
+
uri: uri,
|
691
|
+
body: body || "",
|
692
|
+
params: query_string_params,
|
693
|
+
method_name: "list_operations",
|
689
694
|
options: options
|
690
695
|
)
|
691
696
|
operation = ::Gapic::Rest::TransportOperation.new response
|
692
697
|
result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
|
693
|
-
|
694
|
-
|
695
|
-
|
698
|
+
catch :response do
|
699
|
+
yield result, operation if block_given?
|
700
|
+
result
|
701
|
+
end
|
696
702
|
end
|
697
703
|
|
698
704
|
##
|
@@ -721,16 +727,18 @@ module Google
|
|
721
727
|
|
722
728
|
response = @client_stub.make_http_request(
|
723
729
|
verb,
|
724
|
-
uri:
|
725
|
-
body:
|
726
|
-
params:
|
730
|
+
uri: uri,
|
731
|
+
body: body || "",
|
732
|
+
params: query_string_params,
|
733
|
+
method_name: "get_operation",
|
727
734
|
options: options
|
728
735
|
)
|
729
736
|
operation = ::Gapic::Rest::TransportOperation.new response
|
730
737
|
result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
|
731
|
-
|
732
|
-
|
733
|
-
|
738
|
+
catch :response do
|
739
|
+
yield result, operation if block_given?
|
740
|
+
result
|
741
|
+
end
|
734
742
|
end
|
735
743
|
|
736
744
|
##
|
@@ -759,16 +767,18 @@ module Google
|
|
759
767
|
|
760
768
|
response = @client_stub.make_http_request(
|
761
769
|
verb,
|
762
|
-
uri:
|
763
|
-
body:
|
764
|
-
params:
|
770
|
+
uri: uri,
|
771
|
+
body: body || "",
|
772
|
+
params: query_string_params,
|
773
|
+
method_name: "delete_operation",
|
765
774
|
options: options
|
766
775
|
)
|
767
776
|
operation = ::Gapic::Rest::TransportOperation.new response
|
768
777
|
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
769
|
-
|
770
|
-
|
771
|
-
|
778
|
+
catch :response do
|
779
|
+
yield result, operation if block_given?
|
780
|
+
result
|
781
|
+
end
|
772
782
|
end
|
773
783
|
|
774
784
|
##
|
@@ -797,16 +807,18 @@ module Google
|
|
797
807
|
|
798
808
|
response = @client_stub.make_http_request(
|
799
809
|
verb,
|
800
|
-
uri:
|
801
|
-
body:
|
802
|
-
params:
|
810
|
+
uri: uri,
|
811
|
+
body: body || "",
|
812
|
+
params: query_string_params,
|
813
|
+
method_name: "cancel_operation",
|
803
814
|
options: options
|
804
815
|
)
|
805
816
|
operation = ::Gapic::Rest::TransportOperation.new response
|
806
817
|
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
807
|
-
|
808
|
-
|
809
|
-
|
818
|
+
catch :response do
|
819
|
+
yield result, operation if block_given?
|
820
|
+
result
|
821
|
+
end
|
810
822
|
end
|
811
823
|
|
812
824
|
##
|
@@ -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 optimize_tours 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: "optimize_tours",
|
93
106
|
options: options
|
94
107
|
)
|
95
108
|
operation = ::Gapic::Rest::TransportOperation.new response
|
96
109
|
result = ::Google::Cloud::Optimization::V1::OptimizeToursResponse.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_optimize_tours",
|
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
|
@@ -212,6 +215,12 @@ module Google
|
|
212
215
|
# enabled. By default, asynchronous REST clients will not be generated.
|
213
216
|
# This feature will be enabled by default 1 month after launching the
|
214
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.
|
215
224
|
class ExperimentalFeatures
|
216
225
|
include ::Google::Protobuf::MessageExts
|
217
226
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -297,9 +306,28 @@ module Google
|
|
297
306
|
# @!attribute [rw] common
|
298
307
|
# @return [::Google::Api::CommonLanguageSettings]
|
299
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
|
300
319
|
class GoSettings
|
301
320
|
include ::Google::Protobuf::MessageExts
|
302
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
|
303
331
|
end
|
304
332
|
|
305
333
|
# Describes the generator configuration for a method.
|
@@ -375,6 +403,17 @@ module Google
|
|
375
403
|
end
|
376
404
|
end
|
377
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
|
+
|
378
417
|
# The organization for which the client libraries are being published.
|
379
418
|
# Affects the url where generated docs are published, etc.
|
380
419
|
module ClientLibraryOrganization
|
@@ -1729,9 +1729,13 @@ module Google
|
|
1729
1729
|
# @return [::Google::Cloud::Optimization::V1::Location]
|
1730
1730
|
# A point specified using geographic coordinates, including an optional
|
1731
1731
|
# heading.
|
1732
|
+
#
|
1733
|
+
# Note: The following fields are mutually exclusive: `location`, `place_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1732
1734
|
# @!attribute [rw] place_id
|
1733
1735
|
# @return [::String]
|
1734
1736
|
# The POI Place ID associated with the waypoint.
|
1737
|
+
#
|
1738
|
+
# Note: The following fields are mutually exclusive: `place_id`, `location`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1735
1739
|
# @!attribute [rw] side_of_road
|
1736
1740
|
# @return [::Boolean]
|
1737
1741
|
# Indicates that the location of this waypoint is meant to have a preference
|
@@ -2946,9 +2950,13 @@ module Google
|
|
2946
2950
|
# @!attribute [rw] index
|
2947
2951
|
# @return [::Integer]
|
2948
2952
|
# Index of the field if repeated.
|
2953
|
+
#
|
2954
|
+
# Note: The following fields are mutually exclusive: `index`, `key`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
2949
2955
|
# @!attribute [rw] key
|
2950
2956
|
# @return [::String]
|
2951
2957
|
# Key if the field is a map.
|
2958
|
+
#
|
2959
|
+
# Note: The following fields are mutually exclusive: `key`, `index`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
2952
2960
|
# @!attribute [rw] sub_field
|
2953
2961
|
# @return [::Google::Cloud::Optimization::V1::OptimizeToursValidationError::FieldReference]
|
2954
2962
|
# Recursively nested sub-field, if needed.
|
@@ -40,9 +40,11 @@ module Google
|
|
40
40
|
# @!attribute [rw] error
|
41
41
|
# @return [::Google::Rpc::Status]
|
42
42
|
# The error result of the operation in case of failure or cancellation.
|
43
|
+
#
|
44
|
+
# Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
43
45
|
# @!attribute [rw] response
|
44
46
|
# @return [::Google::Protobuf::Any]
|
45
|
-
# The normal response of the operation
|
47
|
+
# The normal, successful response of the operation. If the original
|
46
48
|
# method returns no data on success, such as `Delete`, the response is
|
47
49
|
# `google.protobuf.Empty`. If the original method is standard
|
48
50
|
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
@@ -50,12 +52,15 @@ module Google
|
|
50
52
|
# is the original method name. For example, if the original method name
|
51
53
|
# is `TakeSnapshot()`, the inferred response type is
|
52
54
|
# `TakeSnapshotResponse`.
|
55
|
+
#
|
56
|
+
# Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
53
57
|
class Operation
|
54
58
|
include ::Google::Protobuf::MessageExts
|
55
59
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
60
|
end
|
57
61
|
|
58
|
-
# The request message for
|
62
|
+
# The request message for
|
63
|
+
# Operations.GetOperation.
|
59
64
|
# @!attribute [rw] name
|
60
65
|
# @return [::String]
|
61
66
|
# The name of the operation resource.
|
@@ -64,7 +69,8 @@ module Google
|
|
64
69
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
70
|
end
|
66
71
|
|
67
|
-
# The request message for
|
72
|
+
# The request message for
|
73
|
+
# Operations.ListOperations.
|
68
74
|
# @!attribute [rw] name
|
69
75
|
# @return [::String]
|
70
76
|
# The name of the operation's parent resource.
|
@@ -82,7 +88,8 @@ module Google
|
|
82
88
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
89
|
end
|
84
90
|
|
85
|
-
# The response message for
|
91
|
+
# The response message for
|
92
|
+
# Operations.ListOperations.
|
86
93
|
# @!attribute [rw] operations
|
87
94
|
# @return [::Array<::Google::Longrunning::Operation>]
|
88
95
|
# A list of operations that matches the specified filter in the request.
|
@@ -94,7 +101,8 @@ module Google
|
|
94
101
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
102
|
end
|
96
103
|
|
97
|
-
# The request message for
|
104
|
+
# The request message for
|
105
|
+
# Operations.CancelOperation.
|
98
106
|
# @!attribute [rw] name
|
99
107
|
# @return [::String]
|
100
108
|
# The name of the operation resource to be cancelled.
|
@@ -103,7 +111,8 @@ module Google
|
|
103
111
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
112
|
end
|
105
113
|
|
106
|
-
# The request message for
|
114
|
+
# The request message for
|
115
|
+
# Operations.DeleteOperation.
|
107
116
|
# @!attribute [rw] name
|
108
117
|
# @return [::String]
|
109
118
|
# The name of the operation resource to be deleted.
|
@@ -112,7 +121,8 @@ module Google
|
|
112
121
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
122
|
end
|
114
123
|
|
115
|
-
# The request message for
|
124
|
+
# The request message for
|
125
|
+
# Operations.WaitOperation.
|
116
126
|
# @!attribute [rw] name
|
117
127
|
# @return [::String]
|
118
128
|
# The name of the operation resource to wait on.
|
@@ -130,13 +140,12 @@ module Google
|
|
130
140
|
#
|
131
141
|
# Example:
|
132
142
|
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# }
|
139
|
-
# }
|
143
|
+
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
|
144
|
+
# option (google.longrunning.operation_info) = {
|
145
|
+
# response_type: "ExportResponse"
|
146
|
+
# metadata_type: "ExportMetadata"
|
147
|
+
# };
|
148
|
+
# }
|
140
149
|
# @!attribute [rw] response_type
|
141
150
|
# @return [::String]
|
142
151
|
# Required. The message name of the primary return type for this
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-optimization-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-01-29 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: gapic-common
|
@@ -16,7 +15,7 @@ dependencies:
|
|
16
15
|
requirements:
|
17
16
|
- - ">="
|
18
17
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
18
|
+
version: 0.25.0
|
20
19
|
- - "<"
|
21
20
|
- !ruby/object:Gem::Version
|
22
21
|
version: 2.a
|
@@ -26,7 +25,7 @@ dependencies:
|
|
26
25
|
requirements:
|
27
26
|
- - ">="
|
28
27
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
28
|
+
version: 0.25.0
|
30
29
|
- - "<"
|
31
30
|
- !ruby/object:Gem::Version
|
32
31
|
version: 2.a
|
@@ -91,7 +90,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
|
|
91
90
|
licenses:
|
92
91
|
- Apache-2.0
|
93
92
|
metadata: {}
|
94
|
-
post_install_message:
|
95
93
|
rdoc_options: []
|
96
94
|
require_paths:
|
97
95
|
- lib
|
@@ -99,15 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
99
97
|
requirements:
|
100
98
|
- - ">="
|
101
99
|
- !ruby/object:Gem::Version
|
102
|
-
version: '
|
100
|
+
version: '3.0'
|
103
101
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
104
102
|
requirements:
|
105
103
|
- - ">="
|
106
104
|
- !ruby/object:Gem::Version
|
107
105
|
version: '0'
|
108
106
|
requirements: []
|
109
|
-
rubygems_version: 3.
|
110
|
-
signing_key:
|
107
|
+
rubygems_version: 3.6.2
|
111
108
|
specification_version: 4
|
112
109
|
summary: Cloud Optimization API provides a portfolio of solvers to address common
|
113
110
|
optimization use cases starting with optimal route planning for vehicle fleets.
|