google-cloud-notebooks-v1 0.7.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (17) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/notebooks/v1/managed_notebook_service/client.rb +34 -8
  4. data/lib/google/cloud/notebooks/v1/managed_notebook_service/operations.rb +28 -6
  5. data/lib/google/cloud/notebooks/v1/managed_notebook_service/rest/client.rb +36 -7
  6. data/lib/google/cloud/notebooks/v1/managed_notebook_service/rest/operations.rb +33 -8
  7. data/lib/google/cloud/notebooks/v1/managed_notebook_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/notebooks/v1/notebook_service/client.rb +34 -8
  9. data/lib/google/cloud/notebooks/v1/notebook_service/operations.rb +28 -6
  10. data/lib/google/cloud/notebooks/v1/notebook_service/rest/client.rb +36 -7
  11. data/lib/google/cloud/notebooks/v1/notebook_service/rest/operations.rb +33 -8
  12. data/lib/google/cloud/notebooks/v1/notebook_service/rest/service_stub.rb +14 -2
  13. data/lib/google/cloud/notebooks/v1/version.rb +1 -1
  14. data/proto_docs/google/api/client.rb +14 -0
  15. data/proto_docs/google/cloud/notebooks/v1/execution.rb +1 -0
  16. data/proto_docs/google/cloud/notebooks/v1/instance.rb +1 -0
  17. metadata +9 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c7c9f2c9231a0b8c6ac3dfc43882e49dfec55088c2a9220a14b8d63b7ad9534b
4
- data.tar.gz: b0333fcf6c28fc56d8d323923af7598a8a4e186da6ea011ff2adcad8eab9b944
3
+ metadata.gz: bc29e24c3430bfca40c9b72beb9e9aad85f904db437e2905ce20941e3d7f2fe0
4
+ data.tar.gz: ce377b48e1a7e62f20bc500a0524615137e1105229335677309a0bdcb3d1d679
5
5
  SHA512:
6
- metadata.gz: 2d9f70d06548e713db7395ac246993cb6faa2ae923f14d0d16784c11eb91da9e3424f6af61c319e36dff777f17f5cd46e0827eb9aeda9351d62039bb17547bf5
7
- data.tar.gz: 9a054cc91ee8ef64c255953dc49497606330a5001f2a76169feae6730cfc49302f2e0d3ae793c00048926cb298281e8a3bced323ab838bdc105db027a5c6b5d0
6
+ metadata.gz: e8bc799a793be57eceb435389fdedbbca6043857fa9aaa742c312cfae7254e85f867cb5858d99e37edcbc8d2c0081553d97b8698ec5d168b89b51cdc6ec8b48d
7
+ data.tar.gz: ab57216ef0bccf46729c14494aa2fb0340eb7f7e97943a14c8758e94180681427850bd4b29dc2c5d3936bfba0aa8017be7254237644084b2905df6a6352f431d
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-notebooks-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-notebooks-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 NOTEBOOKS_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/notebooks/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::Notebooks::V1::ManagedNotebookService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-notebooks-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-notebooks-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-notebooks-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Notebooks::V1::ManagedNotebookService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `NOTEBOOKS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `NOTEBOOKS_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `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)
74
41
 
75
- ```ruby
76
- require "google/cloud/notebooks/v1"
77
-
78
- ENV["NOTEBOOKS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.new
81
- ```
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).
82
49
 
83
- ### 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.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/notebooks/v1"
90
58
 
91
59
  client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/notebooks/v1"
100
68
 
101
69
  ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- 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.
113
82
 
114
- 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).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 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-notebooks-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *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
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/notebooks/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-notebooks-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *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.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- 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.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- 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).
data/lib/google/cloud/notebooks/v1/managed_notebook_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # API v1 service for Managed Notebooks.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "notebooks.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @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
+ @managed_notebook_service_stub.universe_domain
130
+ end
131
+
120
132
  ##
121
133
  # Create a new ManagedNotebookService 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,24 +177,29 @@ 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
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
176
191
  config.credentials = credentials
177
192
  config.quota_project = @quota_project_id
178
193
  config.endpoint = @config.endpoint
194
+ config.universe_domain = @config.universe_domain
179
195
  end
180
196
 
181
197
  @managed_notebook_service_stub = ::Gapic::ServiceStub.new(
182
198
  ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Stub,
183
- credentials: credentials,
184
- endpoint: @config.endpoint,
199
+ credentials: credentials,
200
+ endpoint: @config.endpoint,
201
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
202
+ universe_domain: @config.universe_domain,
185
203
  channel_args: @config.channel_args,
186
204
  interceptors: @config.interceptors,
187
205
  channel_pool_config: @config.channel_pool
@@ -1516,9 +1534,9 @@ module Google
1516
1534
  # end
1517
1535
  #
1518
1536
  # @!attribute [rw] endpoint
1519
- # The hostname or hostname:port of the service endpoint.
1520
- # Defaults to `"notebooks.googleapis.com"`.
1521
- # @return [::String]
1537
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1538
+ # nil, indicating to use the default endpoint in the current universe domain.
1539
+ # @return [::String,nil]
1522
1540
  # @!attribute [rw] credentials
1523
1541
  # Credentials to send with calls. You may provide any of the following types:
1524
1542
  # * (`String`) The path to a service account key file in JSON format
@@ -1564,13 +1582,20 @@ module Google
1564
1582
  # @!attribute [rw] quota_project
1565
1583
  # A separate project against which to charge quota.
1566
1584
  # @return [::String]
1585
+ # @!attribute [rw] universe_domain
1586
+ # The universe domain within which to make requests. This determines the
1587
+ # default endpoint URL. The default value of nil uses the environment
1588
+ # universe (usually the default "googleapis.com" universe).
1589
+ # @return [::String,nil]
1567
1590
  #
1568
1591
  class Configuration
1569
1592
  extend ::Gapic::Config
1570
1593
 
1594
+ # @private
1595
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1571
1596
  DEFAULT_ENDPOINT = "notebooks.googleapis.com"
1572
1597
 
1573
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1598
+ config_attr :endpoint, nil, ::String, nil
1574
1599
  config_attr :credentials, nil do |value|
1575
1600
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1576
1601
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1585,6 +1610,7 @@ module Google
1585
1610
  config_attr :metadata, nil, ::Hash, nil
1586
1611
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1587
1612
  config_attr :quota_project, nil, ::String, nil
1613
+ config_attr :universe_domain, nil, ::String, nil
1588
1614
 
1589
1615
  # @private
1590
1616
  def initialize parent_config = nil
data/lib/google/cloud/notebooks/v1/managed_notebook_service/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module ManagedNotebookService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "notebooks.$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 `"notebooks.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 = "notebooks.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
data/lib/google/cloud/notebooks/v1/managed_notebook_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # API v1 service for Managed Notebooks.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "notebooks.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @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
+ @managed_notebook_service_stub.universe_domain
132
+ end
133
+
122
134
  ##
123
135
  # Create a new ManagedNotebookService 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,12 +174,14 @@ 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
 
@@ -174,10 +189,16 @@ module Google
174
189
  config.credentials = credentials
175
190
  config.quota_project = @quota_project_id
176
191
  config.endpoint = @config.endpoint
192
+ config.universe_domain = @config.universe_domain
177
193
  config.bindings_override = @config.bindings_override
178
194
  end
179
195
 
180
- @managed_notebook_service_stub = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
196
+ @managed_notebook_service_stub = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::ServiceStub.new(
197
+ endpoint: @config.endpoint,
198
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
199
+ universe_domain: @config.universe_domain,
200
+ credentials: credentials
201
+ )
181
202
  end
182
203
 
183
204
  ##
@@ -1416,9 +1437,9 @@ module Google
1416
1437
  # end
1417
1438
  #
1418
1439
  # @!attribute [rw] endpoint
1419
- # The hostname or hostname:port of the service endpoint.
1420
- # Defaults to `"notebooks.googleapis.com"`.
1421
- # @return [::String]
1440
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1441
+ # nil, indicating to use the default endpoint in the current universe domain.
1442
+ # @return [::String,nil]
1422
1443
  # @!attribute [rw] credentials
1423
1444
  # Credentials to send with calls. You may provide any of the following types:
1424
1445
  # * (`String`) The path to a service account key file in JSON format
@@ -1455,13 +1476,20 @@ module Google
1455
1476
  # @!attribute [rw] quota_project
1456
1477
  # A separate project against which to charge quota.
1457
1478
  # @return [::String]
1479
+ # @!attribute [rw] universe_domain
1480
+ # The universe domain within which to make requests. This determines the
1481
+ # default endpoint URL. The default value of nil uses the environment
1482
+ # universe (usually the default "googleapis.com" universe).
1483
+ # @return [::String,nil]
1458
1484
  #
1459
1485
  class Configuration
1460
1486
  extend ::Gapic::Config
1461
1487
 
1488
+ # @private
1489
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1462
1490
  DEFAULT_ENDPOINT = "notebooks.googleapis.com"
1463
1491
 
1464
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1492
+ config_attr :endpoint, nil, ::String, nil
1465
1493
  config_attr :credentials, nil do |value|
1466
1494
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1467
1495
  allowed.any? { |klass| klass === value }
@@ -1473,6 +1501,7 @@ module Google
1473
1501
  config_attr :metadata, nil, ::Hash, nil
1474
1502
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1475
1503
  config_attr :quota_project, nil, ::String, nil
1504
+ config_attr :universe_domain, nil, ::String, nil
1476
1505
 
1477
1506
  # @private
1478
1507
  # Overrides for http bindings for the RPCs of this service
data/lib/google/cloud/notebooks/v1/managed_notebook_service/rest/operations.rb CHANGED
@@ -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 = "notebooks.$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 `"notebooks.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 = "notebooks.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
  ##
data/lib/google/cloud/notebooks/v1/managed_notebook_service/rest/service_stub.rb CHANGED
@@ -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 list_runtimes REST call
45
57
  #
data/lib/google/cloud/notebooks/v1/notebook_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # API v1 service for Cloud AI Platform Notebooks.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "notebooks.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -161,6 +164,15 @@ module Google
161
164
  @config
162
165
  end
163
166
 
167
+ ##
168
+ # The effective universe domain
169
+ #
170
+ # @return [String]
171
+ #
172
+ def universe_domain
173
+ @notebook_service_stub.universe_domain
174
+ end
175
+
164
176
  ##
165
177
  # Create a new NotebookService client object.
166
178
  #
@@ -194,8 +206,9 @@ module Google
194
206
  credentials = @config.credentials
195
207
  # Use self-signed JWT if the endpoint is unchanged from default,
196
208
  # but only if the default endpoint does not have a region prefix.
197
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
198
- !@config.endpoint.split(".").first.include?("-")
209
+ enable_self_signed_jwt = @config.endpoint.nil? ||
210
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
211
+ !@config.endpoint.split(".").first.include?("-"))
199
212
  credentials ||= Credentials.default scope: @config.scope,
200
213
  enable_self_signed_jwt: enable_self_signed_jwt
201
214
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -208,24 +221,29 @@ module Google
208
221
  config.credentials = credentials
209
222
  config.quota_project = @quota_project_id
210
223
  config.endpoint = @config.endpoint
224
+ config.universe_domain = @config.universe_domain
211
225
  end
212
226
 
213
227
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
214
228
  config.credentials = credentials
215
229
  config.quota_project = @quota_project_id
216
230
  config.endpoint = @config.endpoint
231
+ config.universe_domain = @config.universe_domain
217
232
  end
218
233
 
219
234
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
220
235
  config.credentials = credentials
221
236
  config.quota_project = @quota_project_id
222
237
  config.endpoint = @config.endpoint
238
+ config.universe_domain = @config.universe_domain
223
239
  end
224
240
 
225
241
  @notebook_service_stub = ::Gapic::ServiceStub.new(
226
242
  ::Google::Cloud::Notebooks::V1::NotebookService::Stub,
227
- credentials: credentials,
228
- endpoint: @config.endpoint,
243
+ credentials: credentials,
244
+ endpoint: @config.endpoint,
245
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
246
+ universe_domain: @config.universe_domain,
229
247
  channel_args: @config.channel_args,
230
248
  interceptors: @config.interceptors,
231
249
  channel_pool_config: @config.channel_pool
@@ -3514,9 +3532,9 @@ module Google
3514
3532
  # end
3515
3533
  #
3516
3534
  # @!attribute [rw] endpoint
3517
- # The hostname or hostname:port of the service endpoint.
3518
- # Defaults to `"notebooks.googleapis.com"`.
3519
- # @return [::String]
3535
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3536
+ # nil, indicating to use the default endpoint in the current universe domain.
3537
+ # @return [::String,nil]
3520
3538
  # @!attribute [rw] credentials
3521
3539
  # Credentials to send with calls. You may provide any of the following types:
3522
3540
  # * (`String`) The path to a service account key file in JSON format
@@ -3562,13 +3580,20 @@ module Google
3562
3580
  # @!attribute [rw] quota_project
3563
3581
  # A separate project against which to charge quota.
3564
3582
  # @return [::String]
3583
+ # @!attribute [rw] universe_domain
3584
+ # The universe domain within which to make requests. This determines the
3585
+ # default endpoint URL. The default value of nil uses the environment
3586
+ # universe (usually the default "googleapis.com" universe).
3587
+ # @return [::String,nil]
3565
3588
  #
3566
3589
  class Configuration
3567
3590
  extend ::Gapic::Config
3568
3591
 
3592
+ # @private
3593
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3569
3594
  DEFAULT_ENDPOINT = "notebooks.googleapis.com"
3570
3595
 
3571
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3596
+ config_attr :endpoint, nil, ::String, nil
3572
3597
  config_attr :credentials, nil do |value|
3573
3598
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3574
3599
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3583,6 +3608,7 @@ module Google
3583
3608
  config_attr :metadata, nil, ::Hash, nil
3584
3609
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3585
3610
  config_attr :quota_project, nil, ::String, nil
3611
+ config_attr :universe_domain, nil, ::String, nil
3586
3612
 
3587
3613
  # @private
3588
3614
  def initialize parent_config = nil
data/lib/google/cloud/notebooks/v1/notebook_service/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module NotebookService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "notebooks.$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 `"notebooks.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 = "notebooks.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
data/lib/google/cloud/notebooks/v1/notebook_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # API v1 service for Cloud AI Platform Notebooks.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "notebooks.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -163,6 +166,15 @@ module Google
163
166
  @config
164
167
  end
165
168
 
169
+ ##
170
+ # The effective universe domain
171
+ #
172
+ # @return [String]
173
+ #
174
+ def universe_domain
175
+ @notebook_service_stub.universe_domain
176
+ end
177
+
166
178
  ##
167
179
  # Create a new NotebookService REST client object.
168
180
  #
@@ -190,8 +202,9 @@ module Google
190
202
  credentials = @config.credentials
191
203
  # Use self-signed JWT if the endpoint is unchanged from default,
192
204
  # but only if the default endpoint does not have a region prefix.
193
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
194
- !@config.endpoint.split(".").first.include?("-")
205
+ enable_self_signed_jwt = @config.endpoint.nil? ||
206
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
207
+ !@config.endpoint.split(".").first.include?("-"))
195
208
  credentials ||= Credentials.default scope: @config.scope,
196
209
  enable_self_signed_jwt: enable_self_signed_jwt
197
210
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -205,12 +218,14 @@ module Google
205
218
  config.credentials = credentials
206
219
  config.quota_project = @quota_project_id
207
220
  config.endpoint = @config.endpoint
221
+ config.universe_domain = @config.universe_domain
208
222
  end
209
223
 
210
224
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
211
225
  config.credentials = credentials
212
226
  config.quota_project = @quota_project_id
213
227
  config.endpoint = @config.endpoint
228
+ config.universe_domain = @config.universe_domain
214
229
  config.bindings_override = @config.bindings_override
215
230
  end
216
231
 
@@ -218,10 +233,16 @@ module Google
218
233
  config.credentials = credentials
219
234
  config.quota_project = @quota_project_id
220
235
  config.endpoint = @config.endpoint
236
+ config.universe_domain = @config.universe_domain
221
237
  config.bindings_override = @config.bindings_override
222
238
  end
223
239
 
224
- @notebook_service_stub = ::Google::Cloud::Notebooks::V1::NotebookService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
240
+ @notebook_service_stub = ::Google::Cloud::Notebooks::V1::NotebookService::Rest::ServiceStub.new(
241
+ endpoint: @config.endpoint,
242
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
243
+ universe_domain: @config.universe_domain,
244
+ credentials: credentials
245
+ )
225
246
  end
226
247
 
227
248
  ##
@@ -3264,9 +3285,9 @@ module Google
3264
3285
  # end
3265
3286
  #
3266
3287
  # @!attribute [rw] endpoint
3267
- # The hostname or hostname:port of the service endpoint.
3268
- # Defaults to `"notebooks.googleapis.com"`.
3269
- # @return [::String]
3288
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3289
+ # nil, indicating to use the default endpoint in the current universe domain.
3290
+ # @return [::String,nil]
3270
3291
  # @!attribute [rw] credentials
3271
3292
  # Credentials to send with calls. You may provide any of the following types:
3272
3293
  # * (`String`) The path to a service account key file in JSON format
@@ -3303,13 +3324,20 @@ module Google
3303
3324
  # @!attribute [rw] quota_project
3304
3325
  # A separate project against which to charge quota.
3305
3326
  # @return [::String]
3327
+ # @!attribute [rw] universe_domain
3328
+ # The universe domain within which to make requests. This determines the
3329
+ # default endpoint URL. The default value of nil uses the environment
3330
+ # universe (usually the default "googleapis.com" universe).
3331
+ # @return [::String,nil]
3306
3332
  #
3307
3333
  class Configuration
3308
3334
  extend ::Gapic::Config
3309
3335
 
3336
+ # @private
3337
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3310
3338
  DEFAULT_ENDPOINT = "notebooks.googleapis.com"
3311
3339
 
3312
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3340
+ config_attr :endpoint, nil, ::String, nil
3313
3341
  config_attr :credentials, nil do |value|
3314
3342
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3315
3343
  allowed.any? { |klass| klass === value }
@@ -3321,6 +3349,7 @@ module Google
3321
3349
  config_attr :metadata, nil, ::Hash, nil
3322
3350
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3323
3351
  config_attr :quota_project, nil, ::String, nil
3352
+ config_attr :universe_domain, nil, ::String, nil
3324
3353
 
3325
3354
  # @private
3326
3355
  # Overrides for http bindings for the RPCs of this service
data/lib/google/cloud/notebooks/v1/notebook_service/rest/operations.rb CHANGED
@@ -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 = "notebooks.$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 `"notebooks.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 = "notebooks.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
  ##
data/lib/google/cloud/notebooks/v1/notebook_service/rest/service_stub.rb CHANGED
@@ -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 list_instances REST call
45
57
  #
data/lib/google/cloud/notebooks/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Notebooks
23
23
  module V1
24
- VERSION = "0.7.0"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -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
data/proto_docs/google/cloud/notebooks/v1/execution.rb CHANGED
@@ -23,6 +23,7 @@ module Google
23
23
  module V1
24
24
  # The description a notebook execution workload.
25
25
  # @!attribute [rw] scale_tier
26
+ # @deprecated This field is deprecated and may be removed in the next major version update.
26
27
  # @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::ScaleTier]
27
28
  # Required. Scale tier of the hardware used for notebook execution.
28
29
  # DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
data/proto_docs/google/cloud/notebooks/v1/instance.rb CHANGED
@@ -381,6 +381,7 @@ module Google
381
381
  # @return [::Google::Protobuf::Timestamp]
382
382
  # The time that this instance upgrade history entry is created.
383
383
  # @!attribute [rw] target_image
384
+ # @deprecated This field is deprecated and may be removed in the next major version update.
384
385
  # @return [::String]
385
386
  # Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
386
387
  # @!attribute [rw] action
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-notebooks-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-09-12 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
@@ -70,7 +70,7 @@ dependencies:
70
70
  requirements:
71
71
  - - ">="
72
72
  - !ruby/object:Gem::Version
73
- version: '0.4'
73
+ version: '0.7'
74
74
  - - "<"
75
75
  - !ruby/object:Gem::Version
76
76
  version: 2.a
@@ -80,7 +80,7 @@ dependencies:
80
80
  requirements:
81
81
  - - ">="
82
82
  - !ruby/object:Gem::Version
83
- version: '0.4'
83
+ version: '0.7'
84
84
  - - "<"
85
85
  - !ruby/object:Gem::Version
86
86
  version: 2.a
@@ -288,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
288
288
  - !ruby/object:Gem::Version
289
289
  version: '0'
290
290
  requirements: []
291
- rubygems_version: 3.4.19
291
+ rubygems_version: 3.5.3
292
292
  signing_key:
293
293
  specification_version: 4
294
294
  summary: Notebooks API is used to manage notebook resources in Google Cloud.