google-cloud-talent-v4beta1 0.9.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/talent/v4beta1/company_service/client.rb +31 -8
  4. data/lib/google/cloud/talent/v4beta1/company_service/rest/client.rb +33 -7
  5. data/lib/google/cloud/talent/v4beta1/company_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/talent/v4beta1/completion/client.rb +31 -8
  7. data/lib/google/cloud/talent/v4beta1/completion/rest/client.rb +33 -7
  8. data/lib/google/cloud/talent/v4beta1/completion/rest/service_stub.rb +14 -2
  9. data/lib/google/cloud/talent/v4beta1/event_service/client.rb +31 -8
  10. data/lib/google/cloud/talent/v4beta1/event_service/rest/client.rb +33 -7
  11. data/lib/google/cloud/talent/v4beta1/event_service/rest/service_stub.rb +14 -2
  12. data/lib/google/cloud/talent/v4beta1/job_service/client.rb +32 -8
  13. data/lib/google/cloud/talent/v4beta1/job_service/operations.rb +28 -6
  14. data/lib/google/cloud/talent/v4beta1/job_service/rest/client.rb +34 -7
  15. data/lib/google/cloud/talent/v4beta1/job_service/rest/operations.rb +33 -8
  16. data/lib/google/cloud/talent/v4beta1/job_service/rest/service_stub.rb +14 -2
  17. data/lib/google/cloud/talent/v4beta1/tenant_service/client.rb +31 -8
  18. data/lib/google/cloud/talent/v4beta1/tenant_service/rest/client.rb +33 -7
  19. data/lib/google/cloud/talent/v4beta1/tenant_service/rest/service_stub.rb +14 -2
  20. data/lib/google/cloud/talent/v4beta1/version.rb +1 -1
  21. data/proto_docs/google/api/client.rb +14 -0
  22. data/proto_docs/google/cloud/talent/v4beta1/common.rb +1 -0
  23. data/proto_docs/google/cloud/talent/v4beta1/company.rb +1 -0
  24. data/proto_docs/google/cloud/talent/v4beta1/job.rb +1 -0
  25. data/proto_docs/google/cloud/talent/v4beta1/job_service.rb +1 -0
  26. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fff4cd81ad861ca43569f28ee60c260312a51f5786a4d75b433f75f48a0a445a
4
- data.tar.gz: 7140bf03eb0509259803b817c6aa5f5c3333fb9db4d1658f76dbea1a95bffe38
3
+ metadata.gz: cfca61daa5a7538c5f2fb21e2fcd1f67e7e633bf8979a5ff371125cb9e8d6342
4
+ data.tar.gz: 587dedc1ed1f7b92c9d20829a6f6881b1c3d13b5617abaf70296a90e587db012
5
5
  SHA512:
6
- metadata.gz: c3a1360276bdfaf4d05434f75cfa5ad883fa8efcfb2f4170d8911cc49e4b526c8debb0c50e9113f9edceae68e2b4d0d8bfffa736e10df6acc10bef3470d86820
7
- data.tar.gz: 51318bdb23b043f0b4f0c0141aadc053e9da745dec31f84487d602100b3508f4bec701a7b7a5f1716e784a038f9c416be2636b2c81b48e50373cfb2e3ecdc88d
6
+ metadata.gz: 27dfd68ce0d86f3db18f4ee3a022cd0ecafb25762dc1d783daad71f9ee63ab98e874b9359b9ab62c63baf9a5a875d0af9b201d10515fc0415d5adb2be4e211c0
7
+ data.tar.gz: 06d36209b19832dbd4a13f741ebda6ab111ca95f384cadc43e9bbf74b3e2f31959a504f63afe6a2c68a2f279c9305c2ef04761e036e9fef947174045880cd2d5
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-talent-v4beta1 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-talent-v4beta1 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 TALENT_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/talent/v4beta1"
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::Talent::V4beta1::CompanyService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-talent-v4beta1 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-talent-v4beta1 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-talent-v4beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Talent::V4beta1::CompanyService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `TALENT_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `TALENT_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/talent/v4beta1"
77
-
78
- ENV["TALENT_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Talent::V4beta1::CompanyService::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/talent/v4beta1"
90
58
 
91
59
  client = ::Google::Cloud::Talent::V4beta1::CompanyService::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/talent/v4beta1"
100
68
 
101
69
  ::Google::Cloud::Talent::V4beta1::CompanyService::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::Talent::V4beta1::CompanyService::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-talent-v4beta1
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/talent/v4beta1"
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-talent-v4beta1.
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::Talent::V4beta1::CompanyService::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/talent/v4beta1/company_service/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # A service that handles company management, including CRUD and enumeration.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -109,6 +112,15 @@ module Google
109
112
  @config
110
113
  end
111
114
 
115
+ ##
116
+ # The effective universe domain
117
+ #
118
+ # @return [String]
119
+ #
120
+ def universe_domain
121
+ @company_service_stub.universe_domain
122
+ end
123
+
112
124
  ##
113
125
  # Create a new CompanyService client object.
114
126
  #
@@ -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)
@@ -154,8 +167,10 @@ module Google
154
167
 
155
168
  @company_service_stub = ::Gapic::ServiceStub.new(
156
169
  ::Google::Cloud::Talent::V4beta1::CompanyService::Stub,
157
- credentials: credentials,
158
- endpoint: @config.endpoint,
170
+ credentials: credentials,
171
+ endpoint: @config.endpoint,
172
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
173
+ universe_domain: @config.universe_domain,
159
174
  channel_args: @config.channel_args,
160
175
  interceptors: @config.interceptors,
161
176
  channel_pool_config: @config.channel_pool
@@ -677,9 +692,9 @@ module Google
677
692
  # end
678
693
  #
679
694
  # @!attribute [rw] endpoint
680
- # The hostname or hostname:port of the service endpoint.
681
- # Defaults to `"jobs.googleapis.com"`.
682
- # @return [::String]
695
+ # A custom service endpoint, as a hostname or hostname:port. The default is
696
+ # nil, indicating to use the default endpoint in the current universe domain.
697
+ # @return [::String,nil]
683
698
  # @!attribute [rw] credentials
684
699
  # Credentials to send with calls. You may provide any of the following types:
685
700
  # * (`String`) The path to a service account key file in JSON format
@@ -725,13 +740,20 @@ module Google
725
740
  # @!attribute [rw] quota_project
726
741
  # A separate project against which to charge quota.
727
742
  # @return [::String]
743
+ # @!attribute [rw] universe_domain
744
+ # The universe domain within which to make requests. This determines the
745
+ # default endpoint URL. The default value of nil uses the environment
746
+ # universe (usually the default "googleapis.com" universe).
747
+ # @return [::String,nil]
728
748
  #
729
749
  class Configuration
730
750
  extend ::Gapic::Config
731
751
 
752
+ # @private
753
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
732
754
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
733
755
 
734
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
756
+ config_attr :endpoint, nil, ::String, nil
735
757
  config_attr :credentials, nil do |value|
736
758
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
737
759
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -746,6 +768,7 @@ module Google
746
768
  config_attr :metadata, nil, ::Hash, nil
747
769
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
748
770
  config_attr :quota_project, nil, ::String, nil
771
+ config_attr :universe_domain, nil, ::String, nil
749
772
 
750
773
  # @private
751
774
  def initialize parent_config = nil
data/lib/google/cloud/talent/v4beta1/company_service/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # A service that handles company management, including CRUD and enumeration.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -111,6 +114,15 @@ module Google
111
114
  @config
112
115
  end
113
116
 
117
+ ##
118
+ # The effective universe domain
119
+ #
120
+ # @return [String]
121
+ #
122
+ def universe_domain
123
+ @company_service_stub.universe_domain
124
+ end
125
+
114
126
  ##
115
127
  # Create a new CompanyService REST client object.
116
128
  #
@@ -138,8 +150,9 @@ module Google
138
150
  credentials = @config.credentials
139
151
  # Use self-signed JWT if the endpoint is unchanged from default,
140
152
  # but only if the default endpoint does not have a region prefix.
141
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
- !@config.endpoint.split(".").first.include?("-")
153
+ enable_self_signed_jwt = @config.endpoint.nil? ||
154
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
155
+ !@config.endpoint.split(".").first.include?("-"))
143
156
  credentials ||= Credentials.default scope: @config.scope,
144
157
  enable_self_signed_jwt: enable_self_signed_jwt
145
158
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -149,7 +162,12 @@ module Google
149
162
  @quota_project_id = @config.quota_project
150
163
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
151
164
 
152
- @company_service_stub = ::Google::Cloud::Talent::V4beta1::CompanyService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
165
+ @company_service_stub = ::Google::Cloud::Talent::V4beta1::CompanyService::Rest::ServiceStub.new(
166
+ endpoint: @config.endpoint,
167
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
168
+ universe_domain: @config.universe_domain,
169
+ credentials: credentials
170
+ )
153
171
  end
154
172
 
155
173
  # Service calls
@@ -632,9 +650,9 @@ module Google
632
650
  # end
633
651
  #
634
652
  # @!attribute [rw] endpoint
635
- # The hostname or hostname:port of the service endpoint.
636
- # Defaults to `"jobs.googleapis.com"`.
637
- # @return [::String]
653
+ # A custom service endpoint, as a hostname or hostname:port. The default is
654
+ # nil, indicating to use the default endpoint in the current universe domain.
655
+ # @return [::String,nil]
638
656
  # @!attribute [rw] credentials
639
657
  # Credentials to send with calls. You may provide any of the following types:
640
658
  # * (`String`) The path to a service account key file in JSON format
@@ -671,13 +689,20 @@ module Google
671
689
  # @!attribute [rw] quota_project
672
690
  # A separate project against which to charge quota.
673
691
  # @return [::String]
692
+ # @!attribute [rw] universe_domain
693
+ # The universe domain within which to make requests. This determines the
694
+ # default endpoint URL. The default value of nil uses the environment
695
+ # universe (usually the default "googleapis.com" universe).
696
+ # @return [::String,nil]
674
697
  #
675
698
  class Configuration
676
699
  extend ::Gapic::Config
677
700
 
701
+ # @private
702
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
678
703
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
679
704
 
680
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
705
+ config_attr :endpoint, nil, ::String, nil
681
706
  config_attr :credentials, nil do |value|
682
707
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
683
708
  allowed.any? { |klass| klass === value }
@@ -689,6 +714,7 @@ module Google
689
714
  config_attr :metadata, nil, ::Hash, nil
690
715
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
691
716
  config_attr :quota_project, nil, ::String, nil
717
+ config_attr :universe_domain, nil, ::String, nil
692
718
 
693
719
  # @private
694
720
  def initialize parent_config = nil
data/lib/google/cloud/talent/v4beta1/company_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 create_company REST call
45
57
  #
data/lib/google/cloud/talent/v4beta1/completion/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # A service handles auto completion.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -95,6 +98,15 @@ module Google
95
98
  @config
96
99
  end
97
100
 
101
+ ##
102
+ # The effective universe domain
103
+ #
104
+ # @return [String]
105
+ #
106
+ def universe_domain
107
+ @completion_stub.universe_domain
108
+ end
109
+
98
110
  ##
99
111
  # Create a new Completion client object.
100
112
  #
@@ -128,8 +140,9 @@ module Google
128
140
  credentials = @config.credentials
129
141
  # Use self-signed JWT if the endpoint is unchanged from default,
130
142
  # but only if the default endpoint does not have a region prefix.
131
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
132
- !@config.endpoint.split(".").first.include?("-")
143
+ enable_self_signed_jwt = @config.endpoint.nil? ||
144
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
+ !@config.endpoint.split(".").first.include?("-"))
133
146
  credentials ||= Credentials.default scope: @config.scope,
134
147
  enable_self_signed_jwt: enable_self_signed_jwt
135
148
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -140,8 +153,10 @@ module Google
140
153
 
141
154
  @completion_stub = ::Gapic::ServiceStub.new(
142
155
  ::Google::Cloud::Talent::V4beta1::Completion::Stub,
143
- credentials: credentials,
144
- endpoint: @config.endpoint,
156
+ credentials: credentials,
157
+ endpoint: @config.endpoint,
158
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
159
+ universe_domain: @config.universe_domain,
145
160
  channel_args: @config.channel_args,
146
161
  interceptors: @config.interceptors,
147
162
  channel_pool_config: @config.channel_pool
@@ -302,9 +317,9 @@ module Google
302
317
  # end
303
318
  #
304
319
  # @!attribute [rw] endpoint
305
- # The hostname or hostname:port of the service endpoint.
306
- # Defaults to `"jobs.googleapis.com"`.
307
- # @return [::String]
320
+ # A custom service endpoint, as a hostname or hostname:port. The default is
321
+ # nil, indicating to use the default endpoint in the current universe domain.
322
+ # @return [::String,nil]
308
323
  # @!attribute [rw] credentials
309
324
  # Credentials to send with calls. You may provide any of the following types:
310
325
  # * (`String`) The path to a service account key file in JSON format
@@ -350,13 +365,20 @@ module Google
350
365
  # @!attribute [rw] quota_project
351
366
  # A separate project against which to charge quota.
352
367
  # @return [::String]
368
+ # @!attribute [rw] universe_domain
369
+ # The universe domain within which to make requests. This determines the
370
+ # default endpoint URL. The default value of nil uses the environment
371
+ # universe (usually the default "googleapis.com" universe).
372
+ # @return [::String,nil]
353
373
  #
354
374
  class Configuration
355
375
  extend ::Gapic::Config
356
376
 
377
+ # @private
378
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
357
379
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
358
380
 
359
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
381
+ config_attr :endpoint, nil, ::String, nil
360
382
  config_attr :credentials, nil do |value|
361
383
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
362
384
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -371,6 +393,7 @@ module Google
371
393
  config_attr :metadata, nil, ::Hash, nil
372
394
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
373
395
  config_attr :quota_project, nil, ::String, nil
396
+ config_attr :universe_domain, nil, ::String, nil
374
397
 
375
398
  # @private
376
399
  def initialize parent_config = nil
data/lib/google/cloud/talent/v4beta1/completion/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # A service handles auto completion.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -97,6 +100,15 @@ module Google
97
100
  @config
98
101
  end
99
102
 
103
+ ##
104
+ # The effective universe domain
105
+ #
106
+ # @return [String]
107
+ #
108
+ def universe_domain
109
+ @completion_stub.universe_domain
110
+ end
111
+
100
112
  ##
101
113
  # Create a new Completion REST client object.
102
114
  #
@@ -124,8 +136,9 @@ module Google
124
136
  credentials = @config.credentials
125
137
  # Use self-signed JWT if the endpoint is unchanged from default,
126
138
  # but only if the default endpoint does not have a region prefix.
127
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
128
- !@config.endpoint.split(".").first.include?("-")
139
+ enable_self_signed_jwt = @config.endpoint.nil? ||
140
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
141
+ !@config.endpoint.split(".").first.include?("-"))
129
142
  credentials ||= Credentials.default scope: @config.scope,
130
143
  enable_self_signed_jwt: enable_self_signed_jwt
131
144
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -135,7 +148,12 @@ module Google
135
148
  @quota_project_id = @config.quota_project
136
149
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
137
150
 
138
- @completion_stub = ::Google::Cloud::Talent::V4beta1::Completion::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
151
+ @completion_stub = ::Google::Cloud::Talent::V4beta1::Completion::Rest::ServiceStub.new(
152
+ endpoint: @config.endpoint,
153
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
154
+ universe_domain: @config.universe_domain,
155
+ credentials: credentials
156
+ )
139
157
  end
140
158
 
141
159
  # Service calls
@@ -285,9 +303,9 @@ module Google
285
303
  # end
286
304
  #
287
305
  # @!attribute [rw] endpoint
288
- # The hostname or hostname:port of the service endpoint.
289
- # Defaults to `"jobs.googleapis.com"`.
290
- # @return [::String]
306
+ # A custom service endpoint, as a hostname or hostname:port. The default is
307
+ # nil, indicating to use the default endpoint in the current universe domain.
308
+ # @return [::String,nil]
291
309
  # @!attribute [rw] credentials
292
310
  # Credentials to send with calls. You may provide any of the following types:
293
311
  # * (`String`) The path to a service account key file in JSON format
@@ -324,13 +342,20 @@ module Google
324
342
  # @!attribute [rw] quota_project
325
343
  # A separate project against which to charge quota.
326
344
  # @return [::String]
345
+ # @!attribute [rw] universe_domain
346
+ # The universe domain within which to make requests. This determines the
347
+ # default endpoint URL. The default value of nil uses the environment
348
+ # universe (usually the default "googleapis.com" universe).
349
+ # @return [::String,nil]
327
350
  #
328
351
  class Configuration
329
352
  extend ::Gapic::Config
330
353
 
354
+ # @private
355
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
331
356
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
332
357
 
333
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
358
+ config_attr :endpoint, nil, ::String, nil
334
359
  config_attr :credentials, nil do |value|
335
360
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
336
361
  allowed.any? { |klass| klass === value }
@@ -342,6 +367,7 @@ module Google
342
367
  config_attr :metadata, nil, ::Hash, nil
343
368
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
344
369
  config_attr :quota_project, nil, ::String, nil
370
+ config_attr :universe_domain, nil, ::String, nil
345
371
 
346
372
  # @private
347
373
  def initialize parent_config = nil