google-cloud-optimization-v1 0.7.0 → 0.8.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: 3e24400fd6d0c6fe39b1cb38ebfb0bc15e9c3e26bff4db7fd6ed3719e3e6d097
4
- data.tar.gz: fb9714d3a00054d2ce50a8283b3f6f097ed272e8ab9a327a7e0c66bb08f70157
3
+ metadata.gz: 289b51b07786e2531cca99c22de32934177cf21bd41f0f228544dbf95c5c3524
4
+ data.tar.gz: e8d6b39c73d9e6af6fc4d8e669b9613a247270386d50ae123567a134c87a033c
5
5
  SHA512:
6
- metadata.gz: c71341a989bab02dffea7e86c3e252ed8b6532514a31c9b6cc82e1b18ca1d51059cd73497034d97bf72b2dec2b9e08a5ba756aecdc1d14a24b7080c12c692a23
7
- data.tar.gz: 99303c0e3a8d5956d13ca6854579827451540e94f805edaa184744337877d4a19b2586daf1ca699b70a1ed8282cc8ecd5aaf26665e991ff26c0bf76685cb195f
6
+ metadata.gz: 1010c452d0297dcdcc3c6a0f252da3ee2251ee765d476559986e3ec2c9831215c79ee5a7769e2620fed437a97de8734d2406993db5b038fda5a29b9ea74f83be
7
+ data.tar.gz: a280f3a0a68fd074e674592a83da7ab6e6a3ef92206751b198e891646b966dcdefb1f8523795357b34dc94377d18bda633fbbc2ce58c438a4d95c80bd95cb17e
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-optimization-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-optimization-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/optimization/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::Optimization::V1::FleetRouting::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-optimization-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-optimization-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-optimization-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Optimization::V1::FleetRouting::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
72
41
 
73
- ```ruby
74
- require "google/cloud/optimization/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::Optimization::V1::FleetRouting::Client.new
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/optimization/v1"
88
58
 
89
59
  client = ::Google::Cloud::Optimization::V1::FleetRouting::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/optimization/v1"
98
68
 
99
69
  ::Google::Cloud::Optimization::V1::FleetRouting::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::Optimization::V1::FleetRouting::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
111
82
 
112
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-optimization-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/optimization/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-optimization-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Optimization::V1::FleetRouting::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -46,6 +46,9 @@ module Google
46
46
  # * at least one of latitude and longitude must be non-zero.
47
47
  #
48
48
  class Client
49
+ # @private
50
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudoptimization.$UNIVERSE_DOMAIN$"
51
+
49
52
  # @private
50
53
  attr_reader :fleet_routing_stub
51
54
 
@@ -114,6 +117,15 @@ module Google
114
117
  @config
115
118
  end
116
119
 
120
+ ##
121
+ # The effective universe domain
122
+ #
123
+ # @return [String]
124
+ #
125
+ def universe_domain
126
+ @fleet_routing_stub.universe_domain
127
+ end
128
+
117
129
  ##
118
130
  # Create a new FleetRouting client object.
119
131
  #
@@ -147,8 +159,9 @@ module Google
147
159
  credentials = @config.credentials
148
160
  # Use self-signed JWT if the endpoint is unchanged from default,
149
161
  # but only if the default endpoint does not have a region prefix.
150
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
151
- !@config.endpoint.split(".").first.include?("-")
162
+ enable_self_signed_jwt = @config.endpoint.nil? ||
163
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
164
+ !@config.endpoint.split(".").first.include?("-"))
152
165
  credentials ||= Credentials.default scope: @config.scope,
153
166
  enable_self_signed_jwt: enable_self_signed_jwt
154
167
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -161,12 +174,15 @@ module Google
161
174
  config.credentials = credentials
162
175
  config.quota_project = @quota_project_id
163
176
  config.endpoint = @config.endpoint
177
+ config.universe_domain = @config.universe_domain
164
178
  end
165
179
 
166
180
  @fleet_routing_stub = ::Gapic::ServiceStub.new(
167
181
  ::Google::Cloud::Optimization::V1::FleetRouting::Stub,
168
- credentials: credentials,
169
- endpoint: @config.endpoint,
182
+ credentials: credentials,
183
+ endpoint: @config.endpoint,
184
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
185
+ universe_domain: @config.universe_domain,
170
186
  channel_args: @config.channel_args,
171
187
  interceptors: @config.interceptors,
172
188
  channel_pool_config: @config.channel_pool
@@ -606,9 +622,9 @@ module Google
606
622
  # end
607
623
  #
608
624
  # @!attribute [rw] endpoint
609
- # The hostname or hostname:port of the service endpoint.
610
- # Defaults to `"cloudoptimization.googleapis.com"`.
611
- # @return [::String]
625
+ # A custom service endpoint, as a hostname or hostname:port. The default is
626
+ # nil, indicating to use the default endpoint in the current universe domain.
627
+ # @return [::String,nil]
612
628
  # @!attribute [rw] credentials
613
629
  # Credentials to send with calls. You may provide any of the following types:
614
630
  # * (`String`) The path to a service account key file in JSON format
@@ -654,13 +670,20 @@ module Google
654
670
  # @!attribute [rw] quota_project
655
671
  # A separate project against which to charge quota.
656
672
  # @return [::String]
673
+ # @!attribute [rw] universe_domain
674
+ # The universe domain within which to make requests. This determines the
675
+ # default endpoint URL. The default value of nil uses the environment
676
+ # universe (usually the default "googleapis.com" universe).
677
+ # @return [::String,nil]
657
678
  #
658
679
  class Configuration
659
680
  extend ::Gapic::Config
660
681
 
682
+ # @private
683
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
661
684
  DEFAULT_ENDPOINT = "cloudoptimization.googleapis.com"
662
685
 
663
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
686
+ config_attr :endpoint, nil, ::String, nil
664
687
  config_attr :credentials, nil do |value|
665
688
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
666
689
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -675,6 +698,7 @@ module Google
675
698
  config_attr :metadata, nil, ::Hash, nil
676
699
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
677
700
  config_attr :quota_project, nil, ::String, nil
701
+ config_attr :universe_domain, nil, ::String, nil
678
702
 
679
703
  # @private
680
704
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module FleetRouting
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudoptimization.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,8 +102,10 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
613
627
  # end
614
628
  #
615
629
  # @!attribute [rw] endpoint
616
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"cloudoptimization.googleapis.com"`.
618
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
619
633
  # @!attribute [rw] credentials
620
634
  # Credentials to send with calls. You may provide any of the following types:
621
635
  # * (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
661
675
  # @!attribute [rw] quota_project
662
676
  # A separate project against which to charge quota.
663
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
664
683
  #
665
684
  class Configuration
666
685
  extend ::Gapic::Config
667
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
668
689
  DEFAULT_ENDPOINT = "cloudoptimization.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
671
692
  config_attr :credentials, nil do |value|
672
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
682
703
  config_attr :metadata, nil, ::Hash, nil
683
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
684
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
685
707
 
686
708
  # @private
687
709
  def initialize parent_config = nil
@@ -48,6 +48,9 @@ module Google
48
48
  # * at least one of latitude and longitude must be non-zero.
49
49
  #
50
50
  class Client
51
+ # @private
52
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudoptimization.$UNIVERSE_DOMAIN$"
53
+
51
54
  # @private
52
55
  attr_reader :fleet_routing_stub
53
56
 
@@ -116,6 +119,15 @@ module Google
116
119
  @config
117
120
  end
118
121
 
122
+ ##
123
+ # The effective universe domain
124
+ #
125
+ # @return [String]
126
+ #
127
+ def universe_domain
128
+ @fleet_routing_stub.universe_domain
129
+ end
130
+
119
131
  ##
120
132
  # Create a new FleetRouting REST client object.
121
133
  #
@@ -143,8 +155,9 @@ module Google
143
155
  credentials = @config.credentials
144
156
  # Use self-signed JWT if the endpoint is unchanged from default,
145
157
  # but only if the default endpoint does not have a region prefix.
146
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
147
- !@config.endpoint.split(".").first.include?("-")
158
+ enable_self_signed_jwt = @config.endpoint.nil? ||
159
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
160
+ !@config.endpoint.split(".").first.include?("-"))
148
161
  credentials ||= Credentials.default scope: @config.scope,
149
162
  enable_self_signed_jwt: enable_self_signed_jwt
150
163
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -158,9 +171,15 @@ module Google
158
171
  config.credentials = credentials
159
172
  config.quota_project = @quota_project_id
160
173
  config.endpoint = @config.endpoint
174
+ config.universe_domain = @config.universe_domain
161
175
  end
162
176
 
163
- @fleet_routing_stub = ::Google::Cloud::Optimization::V1::FleetRouting::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
177
+ @fleet_routing_stub = ::Google::Cloud::Optimization::V1::FleetRouting::Rest::ServiceStub.new(
178
+ endpoint: @config.endpoint,
179
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
180
+ universe_domain: @config.universe_domain,
181
+ credentials: credentials
182
+ )
164
183
  end
165
184
 
166
185
  ##
@@ -582,9 +601,9 @@ module Google
582
601
  # end
583
602
  #
584
603
  # @!attribute [rw] endpoint
585
- # The hostname or hostname:port of the service endpoint.
586
- # Defaults to `"cloudoptimization.googleapis.com"`.
587
- # @return [::String]
604
+ # A custom service endpoint, as a hostname or hostname:port. The default is
605
+ # nil, indicating to use the default endpoint in the current universe domain.
606
+ # @return [::String,nil]
588
607
  # @!attribute [rw] credentials
589
608
  # Credentials to send with calls. You may provide any of the following types:
590
609
  # * (`String`) The path to a service account key file in JSON format
@@ -621,13 +640,20 @@ module Google
621
640
  # @!attribute [rw] quota_project
622
641
  # A separate project against which to charge quota.
623
642
  # @return [::String]
643
+ # @!attribute [rw] universe_domain
644
+ # The universe domain within which to make requests. This determines the
645
+ # default endpoint URL. The default value of nil uses the environment
646
+ # universe (usually the default "googleapis.com" universe).
647
+ # @return [::String,nil]
624
648
  #
625
649
  class Configuration
626
650
  extend ::Gapic::Config
627
651
 
652
+ # @private
653
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
628
654
  DEFAULT_ENDPOINT = "cloudoptimization.googleapis.com"
629
655
 
630
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
656
+ config_attr :endpoint, nil, ::String, nil
631
657
  config_attr :credentials, nil do |value|
632
658
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
633
659
  allowed.any? { |klass| klass === value }
@@ -639,6 +665,7 @@ module Google
639
665
  config_attr :metadata, nil, ::Hash, nil
640
666
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
641
667
  config_attr :quota_project, nil, ::String, nil
668
+ config_attr :universe_domain, nil, ::String, nil
642
669
 
643
670
  # @private
644
671
  def initialize parent_config = nil
@@ -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
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudoptimization.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"cloudoptimization.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "cloudoptimization.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the optimize_tours REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Optimization
23
23
  module V1
24
- VERSION = "0.7.0"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -223,6 +223,7 @@ module Google
223
223
  # Label that may be used to identify this request, reported back in the
224
224
  # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#request_label OptimizeToursResponse.request_label}.
225
225
  # @!attribute [rw] populate_travel_step_polylines
226
+ # @deprecated This field is deprecated and may be removed in the next major version update.
226
227
  # @return [::Boolean]
227
228
  # Deprecated: Use
228
229
  # {::Google::Cloud::Optimization::V1::OptimizeToursRequest#populate_transition_polylines OptimizeToursRequest.populate_transition_polylines}
@@ -305,6 +306,7 @@ module Google
305
306
  # @return [::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics]
306
307
  # Duration, distance and usage metrics for this solution.
307
308
  # @!attribute [rw] total_cost
309
+ # @deprecated This field is deprecated and may be removed in the next major version update.
308
310
  # @return [::Float]
309
311
  # Deprecated: Use
310
312
  # {::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics#total_cost Metrics.total_cost}
@@ -603,6 +605,7 @@ module Google
603
605
  # @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::PrecedenceRule>]
604
606
  # Set of precedence rules which must be enforced in the model.
605
607
  # @!attribute [rw] break_rules
608
+ # @deprecated This field is deprecated and may be removed in the next major version update.
606
609
  # @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::BreakRule>]
607
610
  # Deprecated: No longer used.
608
611
  # Set of break rules used in the model.
@@ -694,6 +697,7 @@ module Google
694
697
  # * before the vehicle start (the vehicle may not start in the middle of
695
698
  # a break), in which case it does not affect the vehicle start time.
696
699
  # * after the vehicle end (ditto, with the vehicle end time).
700
+ # @deprecated This message is deprecated and may be removed in the next major version update.
697
701
  # @!attribute [rw] break_requests
698
702
  # @return [::Array<::Google::Cloud::Optimization::V1::ShipmentModel::BreakRule::BreakRequest>]
699
703
  # Sequence of breaks. See the `BreakRequest` message.
@@ -901,6 +905,7 @@ module Google
901
905
  # related pickup/delivery visits from the performing route.
902
906
  # `precedence_rules` that reference ignored shipments will also be ignored.
903
907
  # @!attribute [rw] demands
908
+ # @deprecated This field is deprecated and may be removed in the next major version update.
904
909
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
905
910
  # Deprecated: Use
906
911
  # {::Google::Cloud::Optimization::V1::Shipment#load_demands Shipment.load_demands}
@@ -988,6 +993,7 @@ module Google
988
993
  # response as `visit_label` in the corresponding
989
994
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit ShipmentRoute.Visit}.
990
995
  # @!attribute [rw] demands
996
+ # @deprecated This field is deprecated and may be removed in the next major version update.
991
997
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
992
998
  # Deprecated: Use
993
999
  # {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#load_demands VisitRequest.load_demands}
@@ -1336,6 +1342,7 @@ module Google
1336
1342
  # If a shipment has a non-empty `allowed_vehicle_indices` field and all of
1337
1343
  # the allowed vehicles are ignored, it is skipped in the response.
1338
1344
  # @!attribute [rw] break_rule_indices
1345
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1339
1346
  # @return [::Array<::Integer>]
1340
1347
  # Deprecated: No longer used.
1341
1348
  # Indices in the `break_rule` field in the source
@@ -1344,16 +1351,19 @@ module Google
1344
1351
  #
1345
1352
  # As of 2018/03, at most one rule index per vehicle can be specified.
1346
1353
  # @!attribute [rw] capacities
1354
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1347
1355
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
1348
1356
  # Deprecated: Use
1349
1357
  # {::Google::Cloud::Optimization::V1::Vehicle#load_limits Vehicle.load_limits}
1350
1358
  # instead.
1351
1359
  # @!attribute [rw] start_load_intervals
1360
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1352
1361
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>]
1353
1362
  # Deprecated: Use
1354
1363
  # {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit#start_load_interval Vehicle.LoadLimit.start_load_interval}
1355
1364
  # instead.
1356
1365
  # @!attribute [rw] end_load_intervals
1366
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1357
1367
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>]
1358
1368
  # Deprecated: Use
1359
1369
  # {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit#end_load_interval Vehicle.LoadLimit.end_load_interval}
@@ -1591,6 +1601,7 @@ module Google
1591
1601
  # Deprecated: Use
1592
1602
  # {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit::Interval Vehicle.LoadLimit.Interval}
1593
1603
  # instead.
1604
+ # @deprecated This message is deprecated and may be removed in the next major version update.
1594
1605
  # @!attribute [rw] type
1595
1606
  # @return [::String]
1596
1607
  # @!attribute [rw] value
@@ -1603,6 +1614,7 @@ module Google
1603
1614
  # Deprecated: Use
1604
1615
  # {::Google::Cloud::Optimization::V1::Vehicle::LoadLimit::Interval Vehicle.LoadLimit.Interval}
1605
1616
  # instead.
1617
+ # @deprecated This message is deprecated and may be removed in the next major version update.
1606
1618
  # @!attribute [rw] type
1607
1619
  # @return [::String]
1608
1620
  # @!attribute [rw] min_value
@@ -1996,6 +2008,7 @@ module Google
1996
2008
  # @return [::Float]
1997
2009
  # Total cost of the route. The sum of all costs in the cost map.
1998
2010
  # @!attribute [rw] end_loads
2011
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1999
2012
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
2000
2013
  # Deprecated: Use
2001
2014
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
@@ -2006,11 +2019,13 @@ module Google
2006
2019
  # loads for quantity types unconstrained by intervals and that don't have any
2007
2020
  # non-zero demand on the route.
2008
2021
  # @!attribute [rw] travel_steps
2022
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2009
2023
  # @return [::Array<::Google::Cloud::Optimization::V1::ShipmentRoute::TravelStep>]
2010
2024
  # Deprecated: Use
2011
2025
  # {::Google::Cloud::Optimization::V1::ShipmentRoute#transitions ShipmentRoute.transitions}
2012
2026
  # instead. Ordered list of travel steps for the route.
2013
2027
  # @!attribute [rw] vehicle_detour
2028
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2014
2029
  # @return [::Google::Protobuf::Duration]
2015
2030
  # Deprecated: No longer used.
2016
2031
  # This field will only be populated at the
@@ -2023,6 +2038,7 @@ module Google
2023
2038
  # It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration
2024
2039
  # from the vehicle's start_location to its `end_location`.
2025
2040
  # @!attribute [rw] delay_before_vehicle_end
2041
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2026
2042
  # @return [::Google::Cloud::Optimization::V1::ShipmentRoute::Delay]
2027
2043
  # Deprecated: Delay occurring before the vehicle end. See
2028
2044
  # {::Google::Cloud::Optimization::V1::TransitionAttributes#delay TransitionAttributes.delay}.
@@ -2034,6 +2050,7 @@ module Google
2034
2050
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#delay_duration ShipmentRoute.Transition.delay_duration}
2035
2051
  # instead. Time interval spent on the route resulting from a
2036
2052
  # {::Google::Cloud::Optimization::V1::TransitionAttributes#delay TransitionAttributes.delay}.
2053
+ # @deprecated This message is deprecated and may be removed in the next major version update.
2037
2054
  # @!attribute [rw] start_time
2038
2055
  # @return [::Google::Protobuf::Timestamp]
2039
2056
  # Start of the delay.
@@ -2098,6 +2115,7 @@ module Google
2098
2115
  # {::Google::Cloud::Optimization::V1::Shipment::VisitRequest#label VisitRequest.label},
2099
2116
  # if specified in the `VisitRequest`.
2100
2117
  # @!attribute [rw] arrival_loads
2118
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2101
2119
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
2102
2120
  # Deprecated: Use
2103
2121
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
@@ -2109,11 +2127,13 @@ module Google
2109
2127
  # Exception: we omit loads for quantity types unconstrained by intervals
2110
2128
  # and that don't have any non-zero demand on the route.
2111
2129
  # @!attribute [rw] delay_before_start
2130
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2112
2131
  # @return [::Google::Cloud::Optimization::V1::ShipmentRoute::Delay]
2113
2132
  # Deprecated: Use
2114
2133
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#delay_duration ShipmentRoute.Transition.delay_duration}
2115
2134
  # instead. Delay occurring before the visit starts.
2116
2135
  # @!attribute [rw] demands
2136
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2117
2137
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
2118
2138
  # Deprecated: Use
2119
2139
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit#load_demands Visit.load_demands}
@@ -2201,6 +2221,7 @@ module Google
2201
2221
  # either added or subtracted to get the next transition's loads, depending
2202
2222
  # on whether the visit was a pickup or a delivery.
2203
2223
  # @!attribute [rw] loads
2224
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2204
2225
  # @return [::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>]
2205
2226
  # Deprecated: Use
2206
2227
  # {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#vehicle_loads Transition.vehicle_loads}
@@ -2270,6 +2291,7 @@ module Google
2270
2291
  #
2271
2292
  # If the vehicle does not have a start_ and/or end_location, the
2272
2293
  # corresponding travel metrics are 0 and/or empty.
2294
+ # @deprecated This message is deprecated and may be removed in the next major version update.
2273
2295
  # @!attribute [rw] duration
2274
2296
  # @return [::Google::Protobuf::Duration]
2275
2297
  # Duration of the travel step.
@@ -2459,6 +2481,7 @@ module Google
2459
2481
  # (resp.
2460
2482
  # {::Google::Cloud::Optimization::V1::AggregatedMetrics#max_loads ShipmentRoute.metrics.max_loads}.
2461
2483
  # @!attribute [rw] costs
2484
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2462
2485
  # @return [::Google::Protobuf::Map{::String => ::Float}]
2463
2486
  # Deprecated: Use
2464
2487
  # {::Google::Cloud::Optimization::V1::ShipmentRoute#route_costs ShipmentRoute.route_costs}
@@ -2466,6 +2489,7 @@ module Google
2466
2489
  # {::Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics#costs OptimizeToursResponse.Metrics.costs}
2467
2490
  # instead.
2468
2491
  # @!attribute [rw] total_cost
2492
+ # @deprecated This field is deprecated and may be removed in the next major version update.
2469
2493
  # @return [::Float]
2470
2494
  # Deprecated: Use
2471
2495
  # {::Google::Cloud::Optimization::V1::ShipmentRoute#route_total_cost ShipmentRoute.route_total_cost}
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-optimization-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-16 00:00:00.000000000 Z
11
+ date: 2024-01-11 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: 0.20.0
19
+ version: 0.21.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: 0.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
218
218
  - !ruby/object:Gem::Version
219
219
  version: '0'
220
220
  requirements: []
221
- rubygems_version: 3.4.19
221
+ rubygems_version: 3.5.3
222
222
  signing_key:
223
223
  specification_version: 4
224
224
  summary: Cloud Optimization API provides a portfolio of solvers to address common