google-cloud-talent-v4beta1 0.8.1 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (27) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/talent/v4beta1/company_service/client.rb +41 -9
  4. data/lib/google/cloud/talent/v4beta1/company_service/rest/client.rb +117 -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 +41 -9
  7. data/lib/google/cloud/talent/v4beta1/completion/rest/client.rb +49 -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 +41 -9
  10. data/lib/google/cloud/talent/v4beta1/event_service/rest/client.rb +49 -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 +42 -9
  13. data/lib/google/cloud/talent/v4beta1/job_service/operations.rb +38 -7
  14. data/lib/google/cloud/talent/v4beta1/job_service/rest/client.rb +212 -7
  15. data/lib/google/cloud/talent/v4beta1/job_service/rest/operations.rb +108 -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 +41 -9
  18. data/lib/google/cloud/talent/v4beta1/tenant_service/rest/client.rb +117 -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/api/field_behavior.rb +14 -0
  23. data/proto_docs/google/cloud/talent/v4beta1/common.rb +1 -0
  24. data/proto_docs/google/cloud/talent/v4beta1/company.rb +1 -0
  25. data/proto_docs/google/cloud/talent/v4beta1/job.rb +1 -0
  26. data/proto_docs/google/cloud/talent/v4beta1/job_service.rb +1 -0
  27. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b87a5a2101287c50027258d1c1e27402e48beb18733fc5da82cd49f7ba1783e7
4
- data.tar.gz: fb044de0aeeaba674c3eaccaea748fc0f737f9fbd77988ac90e2391668464a55
3
+ metadata.gz: cfca61daa5a7538c5f2fb21e2fcd1f67e7e633bf8979a5ff371125cb9e8d6342
4
+ data.tar.gz: 587dedc1ed1f7b92c9d20829a6f6881b1c3d13b5617abaf70296a90e587db012
5
5
  SHA512:
6
- metadata.gz: 64bc85f5e071c2193a16e767b028358e62ce07886251e89846a4cd0a4b1f4db1756d7e523657f2c8974ee6c97c498812d7a58af55d0693b522ed30aa2e9e1adb
7
- data.tar.gz: 495d95557d8181473eb5d683fa37b4be608e62c21e9d6a2537cae5e834e67161b531d7a13949cc882b0526c540002d10940a4e91a9b909f4677379540e91ab23
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).
@@ -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,10 +167,13 @@ 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
- interceptors: @config.interceptors
175
+ interceptors: @config.interceptors,
176
+ channel_pool_config: @config.channel_pool
161
177
  )
162
178
  end
163
179
 
@@ -676,9 +692,9 @@ module Google
676
692
  # end
677
693
  #
678
694
  # @!attribute [rw] endpoint
679
- # The hostname or hostname:port of the service endpoint.
680
- # Defaults to `"jobs.googleapis.com"`.
681
- # @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]
682
698
  # @!attribute [rw] credentials
683
699
  # Credentials to send with calls. You may provide any of the following types:
684
700
  # * (`String`) The path to a service account key file in JSON format
@@ -724,13 +740,20 @@ module Google
724
740
  # @!attribute [rw] quota_project
725
741
  # A separate project against which to charge quota.
726
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]
727
748
  #
728
749
  class Configuration
729
750
  extend ::Gapic::Config
730
751
 
752
+ # @private
753
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
731
754
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
732
755
 
733
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
756
+ config_attr :endpoint, nil, ::String, nil
734
757
  config_attr :credentials, nil do |value|
735
758
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
736
759
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -745,6 +768,7 @@ module Google
745
768
  config_attr :metadata, nil, ::Hash, nil
746
769
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
747
770
  config_attr :quota_project, nil, ::String, nil
771
+ config_attr :universe_domain, nil, ::String, nil
748
772
 
749
773
  # @private
750
774
  def initialize parent_config = nil
@@ -765,6 +789,14 @@ module Google
765
789
  end
766
790
  end
767
791
 
792
+ ##
793
+ # Configuration for the channel pool
794
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
795
+ #
796
+ def channel_pool
797
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
798
+ end
799
+
768
800
  ##
769
801
  # Configuration RPC class for the CompanyService API.
770
802
  #
@@ -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
@@ -187,6 +205,22 @@ module Google
187
205
  # @return [::Google::Cloud::Talent::V4beta1::Company]
188
206
  #
189
207
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
208
+ #
209
+ # @example Basic example
210
+ # require "google/cloud/talent/v4beta1"
211
+ #
212
+ # # Create a client object. The client can be reused for multiple calls.
213
+ # client = Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client.new
214
+ #
215
+ # # Create a request. To set request fields, pass in keyword arguments.
216
+ # request = Google::Cloud::Talent::V4beta1::CreateCompanyRequest.new
217
+ #
218
+ # # Call the create_company method.
219
+ # result = client.create_company request
220
+ #
221
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::Company.
222
+ # p result
223
+ #
190
224
  def create_company request, options = nil
191
225
  raise ::ArgumentError, "request must be provided" if request.nil?
192
226
 
@@ -256,6 +290,22 @@ module Google
256
290
  # @return [::Google::Cloud::Talent::V4beta1::Company]
257
291
  #
258
292
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
293
+ #
294
+ # @example Basic example
295
+ # require "google/cloud/talent/v4beta1"
296
+ #
297
+ # # Create a client object. The client can be reused for multiple calls.
298
+ # client = Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client.new
299
+ #
300
+ # # Create a request. To set request fields, pass in keyword arguments.
301
+ # request = Google::Cloud::Talent::V4beta1::GetCompanyRequest.new
302
+ #
303
+ # # Call the get_company method.
304
+ # result = client.get_company request
305
+ #
306
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::Company.
307
+ # p result
308
+ #
259
309
  def get_company request, options = nil
260
310
  raise ::ArgumentError, "request must be provided" if request.nil?
261
311
 
@@ -331,6 +381,22 @@ module Google
331
381
  # @return [::Google::Cloud::Talent::V4beta1::Company]
332
382
  #
333
383
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
384
+ #
385
+ # @example Basic example
386
+ # require "google/cloud/talent/v4beta1"
387
+ #
388
+ # # Create a client object. The client can be reused for multiple calls.
389
+ # client = Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client.new
390
+ #
391
+ # # Create a request. To set request fields, pass in keyword arguments.
392
+ # request = Google::Cloud::Talent::V4beta1::UpdateCompanyRequest.new
393
+ #
394
+ # # Call the update_company method.
395
+ # result = client.update_company request
396
+ #
397
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::Company.
398
+ # p result
399
+ #
334
400
  def update_company request, options = nil
335
401
  raise ::ArgumentError, "request must be provided" if request.nil?
336
402
 
@@ -401,6 +467,22 @@ module Google
401
467
  # @return [::Google::Protobuf::Empty]
402
468
  #
403
469
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
470
+ #
471
+ # @example Basic example
472
+ # require "google/cloud/talent/v4beta1"
473
+ #
474
+ # # Create a client object. The client can be reused for multiple calls.
475
+ # client = Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client.new
476
+ #
477
+ # # Create a request. To set request fields, pass in keyword arguments.
478
+ # request = Google::Cloud::Talent::V4beta1::DeleteCompanyRequest.new
479
+ #
480
+ # # Call the delete_company method.
481
+ # result = client.delete_company request
482
+ #
483
+ # # The returned object is of type Google::Protobuf::Empty.
484
+ # p result
485
+ #
404
486
  def delete_company request, options = nil
405
487
  raise ::ArgumentError, "request must be provided" if request.nil?
406
488
 
@@ -482,6 +564,26 @@ module Google
482
564
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company>]
483
565
  #
484
566
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
567
+ #
568
+ # @example Basic example
569
+ # require "google/cloud/talent/v4beta1"
570
+ #
571
+ # # Create a client object. The client can be reused for multiple calls.
572
+ # client = Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client.new
573
+ #
574
+ # # Create a request. To set request fields, pass in keyword arguments.
575
+ # request = Google::Cloud::Talent::V4beta1::ListCompaniesRequest.new
576
+ #
577
+ # # Call the list_companies method.
578
+ # result = client.list_companies request
579
+ #
580
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
581
+ # # over elements, and API calls will be issued to fetch pages as needed.
582
+ # result.each do |item|
583
+ # # Each element is of type ::Google::Cloud::Talent::V4beta1::Company.
584
+ # p item
585
+ # end
586
+ #
485
587
  def list_companies request, options = nil
486
588
  raise ::ArgumentError, "request must be provided" if request.nil?
487
589
 
@@ -548,9 +650,9 @@ module Google
548
650
  # end
549
651
  #
550
652
  # @!attribute [rw] endpoint
551
- # The hostname or hostname:port of the service endpoint.
552
- # Defaults to `"jobs.googleapis.com"`.
553
- # @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]
554
656
  # @!attribute [rw] credentials
555
657
  # Credentials to send with calls. You may provide any of the following types:
556
658
  # * (`String`) The path to a service account key file in JSON format
@@ -587,13 +689,20 @@ module Google
587
689
  # @!attribute [rw] quota_project
588
690
  # A separate project against which to charge quota.
589
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]
590
697
  #
591
698
  class Configuration
592
699
  extend ::Gapic::Config
593
700
 
701
+ # @private
702
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
594
703
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
595
704
 
596
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
705
+ config_attr :endpoint, nil, ::String, nil
597
706
  config_attr :credentials, nil do |value|
598
707
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
599
708
  allowed.any? { |klass| klass === value }
@@ -605,6 +714,7 @@ module Google
605
714
  config_attr :metadata, nil, ::Hash, nil
606
715
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
607
716
  config_attr :quota_project, nil, ::String, nil
717
+ config_attr :universe_domain, nil, ::String, nil
608
718
 
609
719
  # @private
610
720
  def initialize parent_config = nil
@@ -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
  #