google-cloud-netapp-v1 0.3.0 → 0.4.1

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: 63ebbbc33e5b741844817501c67651eadd537d1865b579666492f7ff3becb1e5
4
- data.tar.gz: 9578af540e62fb5363559e16588d927fdfb013763aac2161921e93d4789964b2
3
+ metadata.gz: e047f10f0f99fd607a20c2806dcae14e5152fd3723cd98cdbfad99b321572ae0
4
+ data.tar.gz: 86b385a5dc53460c8820992584a804d440cecaca021c6b66f9b759d1a1e20c4c
5
5
  SHA512:
6
- metadata.gz: 5273b34c002754157e540cd74b3873d4506b1ade82ae5f120cb4cb1143fd8d0288a3dd35c76fd23e7922693053d9c1d2c07504d23dfca2c1ce0e1aac6a65affe
7
- data.tar.gz: 01f3cb36d2bc11813397f235932ad3f8272ebcf29d608a7d46b6fa3c61be060fdf5ad0e551b0ef7a1bda6fafa4c0db8f61c34774b5b27d09c33aa242831c7e1a
6
+ metadata.gz: 2437b63551305df85429f20cc447d81b2faee4492a0afb7701ca0f251426040d65d4a9442a4534088f2ceb853dc9dd0c58e80439bbe4ff2f92a24dbbb0c7cc82
7
+ data.tar.gz: dc8fdff3e1214991650349d0b57844d4803e6b2687585a24d777b2fb39cd8a71101972581508545f3228e341983eb97568e26077921dee748b77dca5224f7fb6
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-netapp-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-netapp-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/netapp/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::NetApp::V1::NetApp::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-netapp-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-netapp-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-netapp-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::NetApp::V1::NetApp::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/netapp/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::NetApp::V1::NetApp::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/netapp/v1"
88
58
 
89
59
  client = ::Google::Cloud::NetApp::V1::NetApp::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/netapp/v1"
98
68
 
99
69
  ::Google::Cloud::NetApp::V1::NetApp::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::NetApp::V1::NetApp::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-netapp-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/netapp/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-netapp-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::NetApp::V1::NetApp::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).
@@ -31,6 +31,9 @@ module Google
31
31
  # NetApp Files Google Cloud Service
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "netapp.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -247,6 +250,15 @@ module Google
247
250
  @config
248
251
  end
249
252
 
253
+ ##
254
+ # The effective universe domain
255
+ #
256
+ # @return [String]
257
+ #
258
+ def universe_domain
259
+ @net_app_stub.universe_domain
260
+ end
261
+
250
262
  ##
251
263
  # Create a new NetApp client object.
252
264
  #
@@ -280,8 +292,9 @@ module Google
280
292
  credentials = @config.credentials
281
293
  # Use self-signed JWT if the endpoint is unchanged from default,
282
294
  # but only if the default endpoint does not have a region prefix.
283
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
284
- !@config.endpoint.split(".").first.include?("-")
295
+ enable_self_signed_jwt = @config.endpoint.nil? ||
296
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
297
+ !@config.endpoint.split(".").first.include?("-"))
285
298
  credentials ||= Credentials.default scope: @config.scope,
286
299
  enable_self_signed_jwt: enable_self_signed_jwt
287
300
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -294,22 +307,26 @@ module Google
294
307
  config.credentials = credentials
295
308
  config.quota_project = @quota_project_id
296
309
  config.endpoint = @config.endpoint
297
- end
298
-
299
- @location_client = Google::Cloud::Location::Locations::Client.new do |config|
300
- config.credentials = credentials
301
- config.quota_project = @quota_project_id
302
- config.endpoint = @config.endpoint
310
+ config.universe_domain = @config.universe_domain
303
311
  end
304
312
 
305
313
  @net_app_stub = ::Gapic::ServiceStub.new(
306
314
  ::Google::Cloud::NetApp::V1::NetApp::Stub,
307
- credentials: credentials,
308
- endpoint: @config.endpoint,
315
+ credentials: credentials,
316
+ endpoint: @config.endpoint,
317
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
318
+ universe_domain: @config.universe_domain,
309
319
  channel_args: @config.channel_args,
310
320
  interceptors: @config.interceptors,
311
321
  channel_pool_config: @config.channel_pool
312
322
  )
323
+
324
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
325
+ config.credentials = credentials
326
+ config.quota_project = @quota_project_id
327
+ config.endpoint = @net_app_stub.endpoint
328
+ config.universe_domain = @net_app_stub.universe_domain
329
+ end
313
330
  end
314
331
 
315
332
  ##
@@ -5244,9 +5261,9 @@ module Google
5244
5261
  # end
5245
5262
  #
5246
5263
  # @!attribute [rw] endpoint
5247
- # The hostname or hostname:port of the service endpoint.
5248
- # Defaults to `"netapp.googleapis.com"`.
5249
- # @return [::String]
5264
+ # A custom service endpoint, as a hostname or hostname:port. The default is
5265
+ # nil, indicating to use the default endpoint in the current universe domain.
5266
+ # @return [::String,nil]
5250
5267
  # @!attribute [rw] credentials
5251
5268
  # Credentials to send with calls. You may provide any of the following types:
5252
5269
  # * (`String`) The path to a service account key file in JSON format
@@ -5292,13 +5309,20 @@ module Google
5292
5309
  # @!attribute [rw] quota_project
5293
5310
  # A separate project against which to charge quota.
5294
5311
  # @return [::String]
5312
+ # @!attribute [rw] universe_domain
5313
+ # The universe domain within which to make requests. This determines the
5314
+ # default endpoint URL. The default value of nil uses the environment
5315
+ # universe (usually the default "googleapis.com" universe).
5316
+ # @return [::String,nil]
5295
5317
  #
5296
5318
  class Configuration
5297
5319
  extend ::Gapic::Config
5298
5320
 
5321
+ # @private
5322
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
5299
5323
  DEFAULT_ENDPOINT = "netapp.googleapis.com"
5300
5324
 
5301
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
5325
+ config_attr :endpoint, nil, ::String, nil
5302
5326
  config_attr :credentials, nil do |value|
5303
5327
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
5304
5328
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -5313,6 +5337,7 @@ module Google
5313
5337
  config_attr :metadata, nil, ::Hash, nil
5314
5338
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
5315
5339
  config_attr :quota_project, nil, ::String, nil
5340
+ config_attr :universe_domain, nil, ::String, nil
5316
5341
 
5317
5342
  # @private
5318
5343
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module NetApp
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "netapp.$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 `"netapp.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 = "netapp.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
@@ -33,6 +33,9 @@ module Google
33
33
  # NetApp Files Google Cloud Service
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "netapp.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -249,6 +252,15 @@ module Google
249
252
  @config
250
253
  end
251
254
 
255
+ ##
256
+ # The effective universe domain
257
+ #
258
+ # @return [String]
259
+ #
260
+ def universe_domain
261
+ @net_app_stub.universe_domain
262
+ end
263
+
252
264
  ##
253
265
  # Create a new NetApp REST client object.
254
266
  #
@@ -276,8 +288,9 @@ module Google
276
288
  credentials = @config.credentials
277
289
  # Use self-signed JWT if the endpoint is unchanged from default,
278
290
  # but only if the default endpoint does not have a region prefix.
279
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
280
- !@config.endpoint.split(".").first.include?("-")
291
+ enable_self_signed_jwt = @config.endpoint.nil? ||
292
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
293
+ !@config.endpoint.split(".").first.include?("-"))
281
294
  credentials ||= Credentials.default scope: @config.scope,
282
295
  enable_self_signed_jwt: enable_self_signed_jwt
283
296
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -291,16 +304,23 @@ module Google
291
304
  config.credentials = credentials
292
305
  config.quota_project = @quota_project_id
293
306
  config.endpoint = @config.endpoint
307
+ config.universe_domain = @config.universe_domain
294
308
  end
295
309
 
310
+ @net_app_stub = ::Google::Cloud::NetApp::V1::NetApp::Rest::ServiceStub.new(
311
+ endpoint: @config.endpoint,
312
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
313
+ universe_domain: @config.universe_domain,
314
+ credentials: credentials
315
+ )
316
+
296
317
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
297
318
  config.credentials = credentials
298
319
  config.quota_project = @quota_project_id
299
- config.endpoint = @config.endpoint
320
+ config.endpoint = @net_app_stub.endpoint
321
+ config.universe_domain = @net_app_stub.universe_domain
300
322
  config.bindings_override = @config.bindings_override
301
323
  end
302
-
303
- @net_app_stub = ::Google::Cloud::NetApp::V1::NetApp::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
304
324
  end
305
325
 
306
326
  ##
@@ -4869,9 +4889,9 @@ module Google
4869
4889
  # end
4870
4890
  #
4871
4891
  # @!attribute [rw] endpoint
4872
- # The hostname or hostname:port of the service endpoint.
4873
- # Defaults to `"netapp.googleapis.com"`.
4874
- # @return [::String]
4892
+ # A custom service endpoint, as a hostname or hostname:port. The default is
4893
+ # nil, indicating to use the default endpoint in the current universe domain.
4894
+ # @return [::String,nil]
4875
4895
  # @!attribute [rw] credentials
4876
4896
  # Credentials to send with calls. You may provide any of the following types:
4877
4897
  # * (`String`) The path to a service account key file in JSON format
@@ -4908,13 +4928,20 @@ module Google
4908
4928
  # @!attribute [rw] quota_project
4909
4929
  # A separate project against which to charge quota.
4910
4930
  # @return [::String]
4931
+ # @!attribute [rw] universe_domain
4932
+ # The universe domain within which to make requests. This determines the
4933
+ # default endpoint URL. The default value of nil uses the environment
4934
+ # universe (usually the default "googleapis.com" universe).
4935
+ # @return [::String,nil]
4911
4936
  #
4912
4937
  class Configuration
4913
4938
  extend ::Gapic::Config
4914
4939
 
4940
+ # @private
4941
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
4915
4942
  DEFAULT_ENDPOINT = "netapp.googleapis.com"
4916
4943
 
4917
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
4944
+ config_attr :endpoint, nil, ::String, nil
4918
4945
  config_attr :credentials, nil do |value|
4919
4946
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
4920
4947
  allowed.any? { |klass| klass === value }
@@ -4926,6 +4953,7 @@ module Google
4926
4953
  config_attr :metadata, nil, ::Hash, nil
4927
4954
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
4928
4955
  config_attr :quota_project, nil, ::String, nil
4956
+ config_attr :universe_domain, nil, ::String, nil
4929
4957
 
4930
4958
  # @private
4931
4959
  # 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 = "netapp.$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 `"netapp.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 = "netapp.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,37 @@ 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
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
43
64
  ##
44
65
  # Baseline implementation for the list_storage_pools REST call
45
66
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module NetApp
23
23
  module V1
24
- VERSION = "0.3.0"
24
+ VERSION = "0.4.1"
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
@@ -163,6 +163,7 @@ module Google
163
163
  # @return [::Google::Cloud::NetApp::V1::EncryptionType]
164
164
  # Output only. Specifies the current pool encryption key source.
165
165
  # @!attribute [rw] global_access_allowed
166
+ # @deprecated This field is deprecated and may be removed in the next major version update.
166
167
  # @return [::Boolean]
167
168
  # Deprecated. Used to allow SO pool to access AD or DNS server from other
168
169
  # regions.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-netapp-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-01-03 00:00:00.000000000 Z
11
+ date: 2024-01-12 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