google-cloud-batch-v1 0.14.0 → 0.15.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: afb7cb71a17701777c09290dc60560e6b6e90985f08f2e0c96e899ba3a3dc627
4
- data.tar.gz: fd48c0db76e579eb6a6b4d61976e1fdf89b252faeb89cee0ccb90ef144a7d98c
3
+ metadata.gz: bb7879fa4c707d5e740612c99e7f489e87264293b9c09bd204f77c6259fe65f1
4
+ data.tar.gz: fa19fbaf33855d60f10fbf97901f7273012ab71a8d5f43dcaef6f1470669eca5
5
5
  SHA512:
6
- metadata.gz: dcf442ab107a4666b93e23a0de04984a7e93c6c390704328f8865b8aaf5c82878fe69ed9f41be43d1fbf8e78b26ab875b7179f418b51509dfc0425b7e4ae6a2a
7
- data.tar.gz: 3971170676434af3240171eb409e6f9ef7074448884a2c219885a60c1b356b1d811c542258f6393e8082d3980b9b091b51243022d0118c9d9d953d116e1b4a8c
6
+ metadata.gz: 5516283d79593aca49816ddf8730a9e9c7f58ff761390d75fa1c46c418b4b078ad9680bd0ae5ef57a1ca4392c5f385fb206ddf2fd8add343603e5369bf0da41e
7
+ data.tar.gz: d466e6740c7f0cdd710efcf364a00e2a62dc18e15e17b0512016164b916109239f7d8a26767b58f269bc5fd13acd76cc0ae28a7840fc877c1a3cfa51ed81ebe0
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-batch-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-batch-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/batch/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::Batch::V1::BatchService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-batch-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-batch-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-batch-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Batch::V1::BatchService::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/batch/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::Batch::V1::BatchService::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/batch/v1"
88
58
 
89
59
  client = ::Google::Cloud::Batch::V1::BatchService::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/batch/v1"
98
68
 
99
69
  ::Google::Cloud::Batch::V1::BatchService::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::Batch::V1::BatchService::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-batch-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/batch/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-batch-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::Batch::V1::BatchService::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).
@@ -33,6 +33,9 @@ module Google
33
33
  # Engine VM instances to run the jobs.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "batch.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -117,6 +120,15 @@ module Google
117
120
  @config
118
121
  end
119
122
 
123
+ ##
124
+ # The effective universe domain
125
+ #
126
+ # @return [String]
127
+ #
128
+ def universe_domain
129
+ @batch_service_stub.universe_domain
130
+ end
131
+
120
132
  ##
121
133
  # Create a new BatchService client object.
122
134
  #
@@ -150,8 +162,9 @@ module Google
150
162
  credentials = @config.credentials
151
163
  # Use self-signed JWT if the endpoint is unchanged from default,
152
164
  # but only if the default endpoint does not have a region prefix.
153
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
154
- !@config.endpoint.split(".").first.include?("-")
165
+ enable_self_signed_jwt = @config.endpoint.nil? ||
166
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
167
+ !@config.endpoint.split(".").first.include?("-"))
155
168
  credentials ||= Credentials.default scope: @config.scope,
156
169
  enable_self_signed_jwt: enable_self_signed_jwt
157
170
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -164,18 +177,22 @@ module Google
164
177
  config.credentials = credentials
165
178
  config.quota_project = @quota_project_id
166
179
  config.endpoint = @config.endpoint
180
+ config.universe_domain = @config.universe_domain
167
181
  end
168
182
 
169
183
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
170
184
  config.credentials = credentials
171
185
  config.quota_project = @quota_project_id
172
186
  config.endpoint = @config.endpoint
187
+ config.universe_domain = @config.universe_domain
173
188
  end
174
189
 
175
190
  @batch_service_stub = ::Gapic::ServiceStub.new(
176
191
  ::Google::Cloud::Batch::V1::BatchService::Stub,
177
- credentials: credentials,
178
- endpoint: @config.endpoint,
192
+ credentials: credentials,
193
+ endpoint: @config.endpoint,
194
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
195
+ universe_domain: @config.universe_domain,
179
196
  channel_args: @config.channel_args,
180
197
  interceptors: @config.interceptors,
181
198
  channel_pool_config: @config.channel_pool
@@ -818,9 +835,9 @@ module Google
818
835
  # end
819
836
  #
820
837
  # @!attribute [rw] endpoint
821
- # The hostname or hostname:port of the service endpoint.
822
- # Defaults to `"batch.googleapis.com"`.
823
- # @return [::String]
838
+ # A custom service endpoint, as a hostname or hostname:port. The default is
839
+ # nil, indicating to use the default endpoint in the current universe domain.
840
+ # @return [::String,nil]
824
841
  # @!attribute [rw] credentials
825
842
  # Credentials to send with calls. You may provide any of the following types:
826
843
  # * (`String`) The path to a service account key file in JSON format
@@ -866,13 +883,20 @@ module Google
866
883
  # @!attribute [rw] quota_project
867
884
  # A separate project against which to charge quota.
868
885
  # @return [::String]
886
+ # @!attribute [rw] universe_domain
887
+ # The universe domain within which to make requests. This determines the
888
+ # default endpoint URL. The default value of nil uses the environment
889
+ # universe (usually the default "googleapis.com" universe).
890
+ # @return [::String,nil]
869
891
  #
870
892
  class Configuration
871
893
  extend ::Gapic::Config
872
894
 
895
+ # @private
896
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
873
897
  DEFAULT_ENDPOINT = "batch.googleapis.com"
874
898
 
875
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
899
+ config_attr :endpoint, nil, ::String, nil
876
900
  config_attr :credentials, nil do |value|
877
901
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
878
902
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -887,6 +911,7 @@ module Google
887
911
  config_attr :metadata, nil, ::Hash, nil
888
912
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
889
913
  config_attr :quota_project, nil, ::String, nil
914
+ config_attr :universe_domain, nil, ::String, nil
890
915
 
891
916
  # @private
892
917
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module BatchService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "batch.$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 `"batch.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 = "batch.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
@@ -35,6 +35,9 @@ module Google
35
35
  # Engine VM instances to run the jobs.
36
36
  #
37
37
  class Client
38
+ # @private
39
+ DEFAULT_ENDPOINT_TEMPLATE = "batch.$UNIVERSE_DOMAIN$"
40
+
38
41
  include Paths
39
42
 
40
43
  # @private
@@ -119,6 +122,15 @@ module Google
119
122
  @config
120
123
  end
121
124
 
125
+ ##
126
+ # The effective universe domain
127
+ #
128
+ # @return [String]
129
+ #
130
+ def universe_domain
131
+ @batch_service_stub.universe_domain
132
+ end
133
+
122
134
  ##
123
135
  # Create a new BatchService REST client object.
124
136
  #
@@ -146,8 +158,9 @@ module Google
146
158
  credentials = @config.credentials
147
159
  # Use self-signed JWT if the endpoint is unchanged from default,
148
160
  # but only if the default endpoint does not have a region prefix.
149
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
150
- !@config.endpoint.split(".").first.include?("-")
161
+ enable_self_signed_jwt = @config.endpoint.nil? ||
162
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
163
+ !@config.endpoint.split(".").first.include?("-"))
151
164
  credentials ||= Credentials.default scope: @config.scope,
152
165
  enable_self_signed_jwt: enable_self_signed_jwt
153
166
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -161,16 +174,23 @@ 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
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
167
181
  config.credentials = credentials
168
182
  config.quota_project = @quota_project_id
169
183
  config.endpoint = @config.endpoint
184
+ config.universe_domain = @config.universe_domain
170
185
  config.bindings_override = @config.bindings_override
171
186
  end
172
187
 
173
- @batch_service_stub = ::Google::Cloud::Batch::V1::BatchService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
188
+ @batch_service_stub = ::Google::Cloud::Batch::V1::BatchService::Rest::ServiceStub.new(
189
+ endpoint: @config.endpoint,
190
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
191
+ universe_domain: @config.universe_domain,
192
+ credentials: credentials
193
+ )
174
194
  end
175
195
 
176
196
  ##
@@ -765,9 +785,9 @@ module Google
765
785
  # end
766
786
  #
767
787
  # @!attribute [rw] endpoint
768
- # The hostname or hostname:port of the service endpoint.
769
- # Defaults to `"batch.googleapis.com"`.
770
- # @return [::String]
788
+ # A custom service endpoint, as a hostname or hostname:port. The default is
789
+ # nil, indicating to use the default endpoint in the current universe domain.
790
+ # @return [::String,nil]
771
791
  # @!attribute [rw] credentials
772
792
  # Credentials to send with calls. You may provide any of the following types:
773
793
  # * (`String`) The path to a service account key file in JSON format
@@ -804,13 +824,20 @@ module Google
804
824
  # @!attribute [rw] quota_project
805
825
  # A separate project against which to charge quota.
806
826
  # @return [::String]
827
+ # @!attribute [rw] universe_domain
828
+ # The universe domain within which to make requests. This determines the
829
+ # default endpoint URL. The default value of nil uses the environment
830
+ # universe (usually the default "googleapis.com" universe).
831
+ # @return [::String,nil]
807
832
  #
808
833
  class Configuration
809
834
  extend ::Gapic::Config
810
835
 
836
+ # @private
837
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
811
838
  DEFAULT_ENDPOINT = "batch.googleapis.com"
812
839
 
813
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
840
+ config_attr :endpoint, nil, ::String, nil
814
841
  config_attr :credentials, nil do |value|
815
842
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
816
843
  allowed.any? { |klass| klass === value }
@@ -822,6 +849,7 @@ module Google
822
849
  config_attr :metadata, nil, ::Hash, nil
823
850
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
824
851
  config_attr :quota_project, nil, ::String, nil
852
+ config_attr :universe_domain, nil, ::String, nil
825
853
 
826
854
  # @private
827
855
  # Overrides for http bindings for the RPCs of this service
@@ -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 = "batch.$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 `"batch.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 = "batch.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 create_job REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Batch
23
23
  module V1
24
- VERSION = "0.14.0"
24
+ VERSION = "0.15.0"
25
25
  end
26
26
  end
27
27
  end
@@ -55,6 +55,9 @@ module Google
55
55
  # attached.
56
56
  #
57
57
  class Client
58
+ # @private
59
+ DEFAULT_ENDPOINT_TEMPLATE = "iam-meta-api.$UNIVERSE_DOMAIN$"
60
+
58
61
  # @private
59
62
  attr_reader :iam_policy_stub
60
63
 
@@ -113,6 +116,15 @@ module Google
113
116
  @config
114
117
  end
115
118
 
119
+ ##
120
+ # The effective universe domain
121
+ #
122
+ # @return [String]
123
+ #
124
+ def universe_domain
125
+ @iam_policy_stub.universe_domain
126
+ end
127
+
116
128
  ##
117
129
  # Create a new IAMPolicy client object.
118
130
  #
@@ -146,8 +158,9 @@ module Google
146
158
  credentials = @config.credentials
147
159
  # Use self-signed JWT if the endpoint is unchanged from default,
148
160
  # but only if the default endpoint does not have a region prefix.
149
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
150
- !@config.endpoint.split(".").first.include?("-")
161
+ enable_self_signed_jwt = @config.endpoint.nil? ||
162
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
163
+ !@config.endpoint.split(".").first.include?("-"))
151
164
  credentials ||= Credentials.default scope: @config.scope,
152
165
  enable_self_signed_jwt: enable_self_signed_jwt
153
166
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -160,12 +173,15 @@ module Google
160
173
  config.credentials = credentials
161
174
  config.quota_project = @quota_project_id
162
175
  config.endpoint = @config.endpoint
176
+ config.universe_domain = @config.universe_domain
163
177
  end
164
178
 
165
179
  @iam_policy_stub = ::Gapic::ServiceStub.new(
166
180
  ::Google::Iam::V1::IAMPolicy::Stub,
167
- credentials: credentials,
168
- endpoint: @config.endpoint,
181
+ credentials: credentials,
182
+ endpoint: @config.endpoint,
183
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
184
+ universe_domain: @config.universe_domain,
169
185
  channel_args: @config.channel_args,
170
186
  interceptors: @config.interceptors,
171
187
  channel_pool_config: @config.channel_pool
@@ -499,9 +515,9 @@ module Google
499
515
  # end
500
516
  #
501
517
  # @!attribute [rw] endpoint
502
- # The hostname or hostname:port of the service endpoint.
503
- # Defaults to `"iam-meta-api.googleapis.com"`.
504
- # @return [::String]
518
+ # A custom service endpoint, as a hostname or hostname:port. The default is
519
+ # nil, indicating to use the default endpoint in the current universe domain.
520
+ # @return [::String,nil]
505
521
  # @!attribute [rw] credentials
506
522
  # Credentials to send with calls. You may provide any of the following types:
507
523
  # * (`String`) The path to a service account key file in JSON format
@@ -547,13 +563,20 @@ module Google
547
563
  # @!attribute [rw] quota_project
548
564
  # A separate project against which to charge quota.
549
565
  # @return [::String]
566
+ # @!attribute [rw] universe_domain
567
+ # The universe domain within which to make requests. This determines the
568
+ # default endpoint URL. The default value of nil uses the environment
569
+ # universe (usually the default "googleapis.com" universe).
570
+ # @return [::String,nil]
550
571
  #
551
572
  class Configuration
552
573
  extend ::Gapic::Config
553
574
 
575
+ # @private
576
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
554
577
  DEFAULT_ENDPOINT = "iam-meta-api.googleapis.com"
555
578
 
556
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
579
+ config_attr :endpoint, nil, ::String, nil
557
580
  config_attr :credentials, nil do |value|
558
581
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
559
582
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -568,6 +591,7 @@ module Google
568
591
  config_attr :metadata, nil, ::Hash, nil
569
592
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
570
593
  config_attr :quota_project, nil, ::String, nil
594
+ config_attr :universe_domain, nil, ::String, nil
571
595
 
572
596
  # @private
573
597
  def initialize parent_config = nil
@@ -57,6 +57,9 @@ module Google
57
57
  # attached.
58
58
  #
59
59
  class Client
60
+ # @private
61
+ DEFAULT_ENDPOINT_TEMPLATE = "iam-meta-api.$UNIVERSE_DOMAIN$"
62
+
60
63
  # @private
61
64
  attr_reader :iam_policy_stub
62
65
 
@@ -115,6 +118,15 @@ module Google
115
118
  @config
116
119
  end
117
120
 
121
+ ##
122
+ # The effective universe domain
123
+ #
124
+ # @return [String]
125
+ #
126
+ def universe_domain
127
+ @iam_policy_stub.universe_domain
128
+ end
129
+
118
130
  ##
119
131
  # Create a new IAMPolicy REST client object.
120
132
  #
@@ -142,8 +154,9 @@ module Google
142
154
  credentials = @config.credentials
143
155
  # Use self-signed JWT if the endpoint is unchanged from default,
144
156
  # but only if the default endpoint does not have a region prefix.
145
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
146
- !@config.endpoint.split(".").first.include?("-")
157
+ enable_self_signed_jwt = @config.endpoint.nil? ||
158
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
159
+ !@config.endpoint.split(".").first.include?("-"))
147
160
  credentials ||= Credentials.default scope: @config.scope,
148
161
  enable_self_signed_jwt: enable_self_signed_jwt
149
162
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -157,10 +170,16 @@ module Google
157
170
  config.credentials = credentials
158
171
  config.quota_project = @quota_project_id
159
172
  config.endpoint = @config.endpoint
173
+ config.universe_domain = @config.universe_domain
160
174
  config.bindings_override = @config.bindings_override
161
175
  end
162
176
 
163
- @iam_policy_stub = ::Google::Iam::V1::IAMPolicy::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
177
+ @iam_policy_stub = ::Google::Iam::V1::IAMPolicy::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
  ##
@@ -469,9 +488,9 @@ module Google
469
488
  # end
470
489
  #
471
490
  # @!attribute [rw] endpoint
472
- # The hostname or hostname:port of the service endpoint.
473
- # Defaults to `"iam-meta-api.googleapis.com"`.
474
- # @return [::String]
491
+ # A custom service endpoint, as a hostname or hostname:port. The default is
492
+ # nil, indicating to use the default endpoint in the current universe domain.
493
+ # @return [::String,nil]
475
494
  # @!attribute [rw] credentials
476
495
  # Credentials to send with calls. You may provide any of the following types:
477
496
  # * (`String`) The path to a service account key file in JSON format
@@ -508,13 +527,20 @@ module Google
508
527
  # @!attribute [rw] quota_project
509
528
  # A separate project against which to charge quota.
510
529
  # @return [::String]
530
+ # @!attribute [rw] universe_domain
531
+ # The universe domain within which to make requests. This determines the
532
+ # default endpoint URL. The default value of nil uses the environment
533
+ # universe (usually the default "googleapis.com" universe).
534
+ # @return [::String,nil]
511
535
  #
512
536
  class Configuration
513
537
  extend ::Gapic::Config
514
538
 
539
+ # @private
540
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
515
541
  DEFAULT_ENDPOINT = "iam-meta-api.googleapis.com"
516
542
 
517
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
543
+ config_attr :endpoint, nil, ::String, nil
518
544
  config_attr :credentials, nil do |value|
519
545
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
520
546
  allowed.any? { |klass| klass === value }
@@ -526,6 +552,7 @@ module Google
526
552
  config_attr :metadata, nil, ::Hash, nil
527
553
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
528
554
  config_attr :quota_project, nil, ::String, nil
555
+ config_attr :universe_domain, nil, ::String, nil
529
556
 
530
557
  # @private
531
558
  # Overrides for http bindings for the RPCs of this service
@@ -29,16 +29,28 @@ module Google
29
29
  # including transcoding, making the REST call, and deserialing the response.
30
30
  #
31
31
  class ServiceStub
32
- def initialize endpoint:, credentials:
32
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
33
  # These require statements are intentionally placed here to initialize
34
34
  # the REST modules only when it's required.
35
35
  require "gapic/rest"
36
36
 
37
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
37
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
38
+ endpoint_template: endpoint_template,
39
+ universe_domain: universe_domain,
40
+ credentials: credentials,
38
41
  numeric_enums: true,
39
42
  raise_faraday_errors: false
40
43
  end
41
44
 
45
+ ##
46
+ # The effective universe domain
47
+ #
48
+ # @return [String]
49
+ #
50
+ def universe_domain
51
+ @client_stub.universe_domain
52
+ end
53
+
42
54
  ##
43
55
  # Baseline implementation for the set_iam_policy REST call
44
56
  #
@@ -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
@@ -415,6 +415,7 @@ module Google
415
415
  # @return [::Integer]
416
416
  # The number of accelerators of this type.
417
417
  # @!attribute [rw] install_gpu_drivers
418
+ # @deprecated This field is deprecated and may be removed in the next major version update.
418
419
  # @return [::Boolean]
419
420
  # Deprecated: please use instances[0].install_gpu_drivers instead.
420
421
  # @!attribute [rw] driver_version
@@ -324,6 +324,7 @@ module Google
324
324
  # Default policy means if the exit code is 0, exit task.
325
325
  # If task ends with non-zero exit code, retry the task with max_retry_count.
326
326
  # @!attribute [rw] environments
327
+ # @deprecated This field is deprecated and may be removed in the next major version update.
327
328
  # @return [::Google::Protobuf::Map{::String => ::String}]
328
329
  # Deprecated: please use environment(non-plural) instead.
329
330
  # @!attribute [rw] volumes
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-batch-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.14.0
4
+ version: 0.15.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-12-04 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
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.4'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -273,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
273
273
  - !ruby/object:Gem::Version
274
274
  version: '0'
275
275
  requirements: []
276
- rubygems_version: 3.4.19
276
+ rubygems_version: 3.5.3
277
277
  signing_key:
278
278
  specification_version: 4
279
279
  summary: An API to manage the running of batch jobs on Google Cloud Platform.