google-cloud-optimization 1.2.1 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 279ec9e2bf308d3e1373b9b1d4ff5b66e5f669a8965e4a986c9cba8dff7b32b5
4
- data.tar.gz: 8f0e8733a105bf66a85676f76ce9e2ac5fd8a9e29eb5d50db99f96f723c0acf9
3
+ metadata.gz: 0be162e643bbfd3fdfdacc7e5a328707f5f9681e360fbfd452d881ba32cc46a2
4
+ data.tar.gz: c541cac9815c4328f3fba64f5fc374ee7413efc082fe741b6e80150388d775ee
5
5
  SHA512:
6
- metadata.gz: b2bb7340befe0e78f448c4144b6095cb67610e0c7caf6c8c6023d12325005b00ea68610d6b8e478e9f4ab141eb71e0b30da99cb4e169bd3067c51607ddd742a6
7
- data.tar.gz: 0024e91e5ba2de6f0618702bd1f407e722c5c710288a39b56e9ed86e24afe6c1d743ff7dd5ea9e5feb6a05d1964011db5173c82ba38c1086dd90392e33e70983
6
+ metadata.gz: 311d420ed1971b842020ce2c80a7a6e41fb296b2090ccd48b7db610a993b1647e6f831cf52ae3c3aee4051083364bf26a1e5ac69c38f11a67ece1205a4a48ddc
7
+ data.tar.gz: 72e5f688c6c86e162a0d56d5224f9fa93187addef5d595ce284b9041f26f1322196ff60bad89c6ed2424f110ff89fd153c58f1bd7d0d64459eff864c8ebf90dc
data/README.md CHANGED
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudoptimization.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-optimization-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-optimization-v1/latest).
66
+
37
67
  ## Supported Ruby Versions
38
68
 
39
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
40
70
 
41
71
  Google provides official support for Ruby versions that are actively supported
42
72
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Optimization
23
- VERSION = "1.2.1"
23
+ VERSION = "1.3.0"
24
24
  end
25
25
  end
26
26
  end
@@ -58,6 +58,11 @@ module Google
58
58
  # You can also specify a different transport by passing `:rest` or `:grpc` in
59
59
  # the `transport` parameter.
60
60
  #
61
+ # Raises an exception if the currently installed versioned client gem for the
62
+ # given API version does not support the given transport of the FleetRouting service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Optimization.fleet_routing_available?}.
65
+ #
61
66
  # ## About FleetRouting
62
67
  #
63
68
  # A service for optimizing vehicle tours.
@@ -95,6 +100,37 @@ module Google
95
100
  service_module.const_get(:Client).new(&block)
96
101
  end
97
102
 
103
+ ##
104
+ # Determines whether the FleetRouting service is supported by the current client.
105
+ # If true, you can retrieve a client object by calling {Google::Cloud::Optimization.fleet_routing}.
106
+ # If false, that method will raise an exception. This could happen if the given
107
+ # API version does not exist or does not support the FleetRouting service,
108
+ # or if the versioned client gem needs an update to support the FleetRouting service.
109
+ #
110
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
111
+ # Defaults to `:v1`.
112
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
113
+ # @return [boolean] Whether the service is available.
114
+ #
115
+ def self.fleet_routing_available? version: :v1, transport: :grpc
116
+ require "google/cloud/optimization/#{version.to_s.downcase}"
117
+ package_name = Google::Cloud::Optimization
118
+ .constants
119
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
120
+ .first
121
+ return false unless package_name
122
+ service_module = Google::Cloud::Optimization.const_get package_name
123
+ return false unless service_module.const_defined? :FleetRouting
124
+ service_module = service_module.const_get :FleetRouting
125
+ if transport == :rest
126
+ return false unless service_module.const_defined? :Rest
127
+ service_module = service_module.const_get :Rest
128
+ end
129
+ service_module.const_defined? :Client
130
+ rescue ::LoadError
131
+ false
132
+ end
133
+
98
134
  ##
99
135
  # Configure the google-cloud-optimization library.
100
136
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-optimization
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.1
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-09 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
62
61
  licenses:
63
62
  - Apache-2.0
64
63
  metadata: {}
65
- post_install_message:
66
64
  rdoc_options: []
67
65
  require_paths:
68
66
  - lib
@@ -70,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
70
68
  requirements:
71
69
  - - ">="
72
70
  - !ruby/object:Gem::Version
73
- version: '2.7'
71
+ version: '3.0'
74
72
  required_rubygems_version: !ruby/object:Gem::Requirement
75
73
  requirements:
76
74
  - - ">="
77
75
  - !ruby/object:Gem::Version
78
76
  version: '0'
79
77
  requirements: []
80
- rubygems_version: 3.5.6
81
- signing_key:
78
+ rubygems_version: 3.6.2
82
79
  specification_version: 4
83
80
  summary: API Client library for the Cloud Optimization API
84
81
  test_files: []