google-cloud-talent 0.8.1 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -59
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +347 -0
  6. data/README.md +35 -25
  7. data/lib/{google/cloud/talent/v4beta1/doc/google/protobuf/empty.rb → google-cloud-talent.rb} +5 -15
  8. data/lib/google/cloud/talent.rb +254 -442
  9. data/lib/google/cloud/talent/version.rb +6 -2
  10. metadata +62 -111
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/talent/v4beta1.rb +0 -543
  13. data/lib/google/cloud/talent/v4beta1/application_pb.rb +0 -62
  14. data/lib/google/cloud/talent/v4beta1/application_service_client.rb +0 -491
  15. data/lib/google/cloud/talent/v4beta1/application_service_client_config.json +0 -51
  16. data/lib/google/cloud/talent/v4beta1/application_service_pb.rb +0 -54
  17. data/lib/google/cloud/talent/v4beta1/application_service_services_pb.rb +0 -56
  18. data/lib/google/cloud/talent/v4beta1/batch_pb.rb +0 -18
  19. data/lib/google/cloud/talent/v4beta1/common_pb.rb +0 -341
  20. data/lib/google/cloud/talent/v4beta1/company_pb.rb +0 -40
  21. data/lib/google/cloud/talent/v4beta1/company_service_client.rb +0 -535
  22. data/lib/google/cloud/talent/v4beta1/company_service_client_config.json +0 -51
  23. data/lib/google/cloud/talent/v4beta1/company_service_pb.rb +0 -55
  24. data/lib/google/cloud/talent/v4beta1/company_service_services_pb.rb +0 -56
  25. data/lib/google/cloud/talent/v4beta1/completion_client.rb +0 -359
  26. data/lib/google/cloud/talent/v4beta1/completion_client_config.json +0 -31
  27. data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb +0 -55
  28. data/lib/google/cloud/talent/v4beta1/completion_service_services_pb.rb +0 -48
  29. data/lib/google/cloud/talent/v4beta1/credentials.rb +0 -42
  30. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application.rb +0 -166
  31. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application_service.rb +0 -107
  32. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb +0 -1147
  33. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb +0 -110
  34. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company_service.rb +0 -122
  35. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb +0 -141
  36. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb +0 -238
  37. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event_service.rb +0 -36
  38. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb +0 -847
  39. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/histogram.rb +0 -55
  40. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb +0 -363
  41. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb +0 -762
  42. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb +0 -808
  43. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb +0 -446
  44. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant.rb +0 -74
  45. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant_service.rb +0 -101
  46. data/lib/google/cloud/talent/v4beta1/doc/google/longrunning/operations.rb +0 -51
  47. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/any.rb +0 -131
  48. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/duration.rb +0 -91
  49. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/field_mask.rb +0 -222
  50. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/timestamp.rb +0 -113
  51. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/wrappers.rb +0 -34
  52. data/lib/google/cloud/talent/v4beta1/doc/google/rpc/status.rb +0 -87
  53. data/lib/google/cloud/talent/v4beta1/doc/google/type/date.rb +0 -43
  54. data/lib/google/cloud/talent/v4beta1/doc/google/type/latlng.rb +0 -31
  55. data/lib/google/cloud/talent/v4beta1/doc/google/type/money.rb +0 -36
  56. data/lib/google/cloud/talent/v4beta1/doc/google/type/postal_address.rb +0 -126
  57. data/lib/google/cloud/talent/v4beta1/doc/google/type/timeofday.rb +0 -37
  58. data/lib/google/cloud/talent/v4beta1/event_pb.rb +0 -69
  59. data/lib/google/cloud/talent/v4beta1/event_service_client.rb +0 -268
  60. data/lib/google/cloud/talent/v4beta1/event_service_client_config.json +0 -31
  61. data/lib/google/cloud/talent/v4beta1/event_service_pb.rb +0 -26
  62. data/lib/google/cloud/talent/v4beta1/event_service_services_pb.rb +0 -53
  63. data/lib/google/cloud/talent/v4beta1/filters_pb.rb +0 -187
  64. data/lib/google/cloud/talent/v4beta1/helpers.rb +0 -162
  65. data/lib/google/cloud/talent/v4beta1/histogram_pb.rb +0 -27
  66. data/lib/google/cloud/talent/v4beta1/job_pb.rb +0 -71
  67. data/lib/google/cloud/talent/v4beta1/job_service_client.rb +0 -1576
  68. data/lib/google/cloud/talent/v4beta1/job_service_client_config.json +0 -76
  69. data/lib/google/cloud/talent/v4beta1/job_service_pb.rb +0 -165
  70. data/lib/google/cloud/talent/v4beta1/job_service_services_pb.rb +0 -92
  71. data/lib/google/cloud/talent/v4beta1/profile_pb.rb +0 -212
  72. data/lib/google/cloud/talent/v4beta1/profile_service_client.rb +0 -844
  73. data/lib/google/cloud/talent/v4beta1/profile_service_client_config.json +0 -56
  74. data/lib/google/cloud/talent/v4beta1/profile_service_pb.rb +0 -88
  75. data/lib/google/cloud/talent/v4beta1/profile_service_services_pb.rb +0 -67
  76. data/lib/google/cloud/talent/v4beta1/tenant_pb.rb +0 -33
  77. data/lib/google/cloud/talent/v4beta1/tenant_service_client.rb +0 -476
  78. data/lib/google/cloud/talent/v4beta1/tenant_service_client_config.json +0 -51
  79. data/lib/google/cloud/talent/v4beta1/tenant_service_pb.rb +0 -54
  80. data/lib/google/cloud/talent/v4beta1/tenant_service_services_pb.rb +0 -55
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f4a6c20f49117968c2a5130b41240450832e1e12f14914976ad794829f451573
4
- data.tar.gz: 2cdbbabbf140ecd55ecbc015a7d14e95f414da1903bcb0264ce6af47a18b0258
3
+ metadata.gz: c04924578c0ce4d41d2997bb4a527f06e5c6a40d2f78ff16a94be680da0424e5
4
+ data.tar.gz: c8b22e96ec8617dfb84c4a0c5ccfc43c12adf9c5fc9cf7646948d1d84457e207
5
5
  SHA512:
6
- metadata.gz: 377aae7b8ef9053770bff9daccb80f574484605aa53b1aeec8a82d48b99b23a37f3f9703bd115c22f3e94e46e53cf63e5002af0d3cb96a60343cf6ec93ec6ac8
7
- data.tar.gz: 2348a6890ed176d117212075ede36905d42e239930876221839889fa96c379831ae572990c84ba79b9047af30dbfc673fa755756b1424057a4e3f4ac9e9f3ec8
6
+ metadata.gz: fcef79fb7f8a04232131d65a537111fd41d8b2817937afd67cc07f52d5bd4b37dc76e2b3e893b46ed35d09e8fbd9bd036509bc775e0a1f499176d88bf9527f2b
7
+ data.tar.gz: 2ff4c44965733c460b39155f37e3adb984139e4421019520efebe086da0a16339b8a33f58005d9d9a0c6b90e2a46e384435f82a9465e14831a510b31de1aaf78
data/.yardopts CHANGED
@@ -8,4 +8,5 @@
8
8
  -
9
9
  README.md
10
10
  AUTHENTICATION.md
11
- LICENSE
11
+ MIGRATING.md
12
+ LICENSE.md
@@ -1,16 +1,17 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-talent library uses [Service
4
- Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within [Google
6
- Cloud Platform environments](#google-cloud-platform-environments)
7
- the credentials will be discovered automatically. When running on other
3
+ In general, the google-cloud-talent 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
8
  environments, the Service Account credentials can be specified by providing the
9
- path to the [JSON
10
- keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
11
- the account (or the JSON itself) in [environment
12
- variables](#environment-variables). Additionally, Cloud SDK credentials can also
13
- be discovered automatically, but this is only recommended during development.
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.
14
15
 
15
16
  ## Quickstart
16
17
 
@@ -18,7 +19,7 @@ be discovered automatically, but this is only recommended during development.
18
19
  2. Set the [environment variable](#environment-variables).
19
20
 
20
21
  ```sh
21
- export TALENT_CREDENTIALS=/path/to/json`
22
+ export TALENT_CREDENTIALS=path/to/keyfile.json
22
23
  ```
23
24
 
24
25
  3. Initialize the client.
@@ -26,23 +27,14 @@ export TALENT_CREDENTIALS=/path/to/json`
26
27
  ```ruby
27
28
  require "google/cloud/talent"
28
29
 
29
- client = Google::Cloud::Talent::ApplicationService.new
30
+ client = Google::Cloud::Talent.application_service
30
31
  ```
31
32
 
32
- ## Project and Credential Lookup
33
+ ## Credential Lookup
33
34
 
34
35
  The google-cloud-talent library aims to make authentication
35
36
  as simple as possible, and provides several mechanisms to configure your system
36
- without providing **Project ID** and **Service Account Credentials** directly in
37
- code.
38
-
39
- **Project ID** is discovered in the following order:
40
-
41
- 1. Specify project ID in method arguments
42
- 2. Specify project ID in configuration
43
- 3. Discover project ID in environment variables
44
- 4. Discover GCP project ID
45
- 5. Discover project ID in credentials JSON
37
+ without requiring **Service Account Credentials** directly in code.
46
38
 
47
39
  **Credentials** are discovered in the following order:
48
40
 
@@ -55,28 +47,24 @@ code.
55
47
 
56
48
  ### Google Cloud Platform environments
57
49
 
58
- When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
59
- Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
60
- (GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
61
- automatically. Code should be written as if already authenticated.
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.
62
54
 
63
55
  ### Environment Variables
64
56
 
65
- The **Project ID** and **Credentials JSON** can be placed in environment
66
- variables instead of declaring them directly in code. Each service has its own
67
- environment variable, allowing for different service accounts to be used for
68
- different services. (See the READMEs for the individual service gems for
69
- details.) The path to the **Credentials JSON** file can be stored in the
70
- environment variable, or the **Credentials JSON** itself can be stored for
71
- environments such as Docker containers where writing files is difficult or not
72
- encouraged.
73
-
74
- The environment variables that google-cloud-talent checks for project ID are:
75
-
76
- 1. `TALENT_PROJECT`
77
- 2. `GOOGLE_CLOUD_PROJECT`
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.
78
64
 
79
- The environment variables that google-cloud-talent checks for credentials are configured on {Google::Cloud::Talent::V4beta1::Credentials}:
65
+ The environment variables that google-cloud-talent
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::Talent::V4beta1::ApplicationService::Credentials`):
80
68
 
81
69
  1. `TALENT_CREDENTIALS` - Path to JSON file, or JSON contents
82
70
  2. `TALENT_KEYFILE` - Path to JSON file, or JSON contents
@@ -87,25 +75,34 @@ The environment variables that google-cloud-talent checks for credentials are co
87
75
  ```ruby
88
76
  require "google/cloud/talent"
89
77
 
90
- ENV["TALENT_PROJECT"] = "my-project-id"
91
78
  ENV["TALENT_CREDENTIALS"] = "path/to/keyfile.json"
92
79
 
93
- client = Google::Cloud::Talent::ApplicationService.new
80
+ client = Google::Cloud::Talent.application_service
94
81
  ```
95
82
 
96
83
  ### Configuration
97
84
 
98
- The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
85
+ The **Credentials JSON** can be configured instead of placing them in
86
+ environment variables. Either on an individual client initialization:
87
+
88
+ ```ruby
89
+ require "google/cloud/talent"
90
+
91
+ client = Google::Cloud::Talent.application_service do |config|
92
+ config.credentials = "path/to/keyfile.json"
93
+ end
94
+ ```
95
+
96
+ Or configured globally for all clients:
99
97
 
100
98
  ```ruby
101
99
  require "google/cloud/talent"
102
100
 
103
101
  Google::Cloud::Talent.configure do |config|
104
- config.project_id = "my-project-id"
105
102
  config.credentials = "path/to/keyfile.json"
106
103
  end
107
104
 
108
- client = Google::Cloud::Talent::ApplicationService.new
105
+ client = Google::Cloud::Talent.application_service
109
106
  ```
110
107
 
111
108
  ### Cloud SDK
@@ -134,24 +131,24 @@ To configure your system for this, simply:
134
131
 
135
132
  ## Creating a Service Account
136
133
 
137
- Google Cloud requires a **Project ID** and **Service Account Credentials** to
138
- connect to the APIs. You will use the **Project ID** and **JSON key file** to
134
+ Google Cloud requires **Service Account Credentials** to
135
+ connect to the APIs. You will use the **JSON key file** to
139
136
  connect to most services with google-cloud-talent.
140
137
 
141
- If you are not running this client within [Google Cloud Platform
142
- environments](#google-cloud-platform-environments), you need a Google
143
- Developers service account.
138
+ If you are not running this client within
139
+ [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
+ need a Google Developers service account.
144
141
 
145
142
  1. Visit the [Google Developers Console][dev-console].
146
- 1. Create a new project or click on an existing project.
147
- 1. Activate the slide-out navigation tray and select **API Manager**. From
143
+ 2. Create a new project or click on an existing project.
144
+ 3. Activate the slide-out navigation tray and select **API Manager**. From
148
145
  here, you will enable the APIs that your application requires.
149
146
 
150
147
  ![Enable the APIs that your application requires][enable-apis]
151
148
 
152
149
  *Note: You may need to enable billing in order to use these services.*
153
150
 
154
- 1. Select **Credentials** from the side navigation.
151
+ 4. Select **Credentials** from the side navigation.
155
152
 
156
153
  You should see a screen like one of the following.
157
154
 
@@ -170,8 +167,3 @@ Developers service account.
170
167
 
171
168
  The key file you download will be used by this library to authenticate API
172
169
  requests and should be stored in a secure location.
173
-
174
- ## Troubleshooting
175
-
176
- If you're having trouble authenticating you can ask for help by following the
177
- {file:TROUBLESHOOTING.md Troubleshooting Guide}.
@@ -0,0 +1,203 @@
1
+ Apache License
2
+ ==============
3
+
4
+ * Version 2.0, January 2004
5
+ * https://www.apache.org/licenses/
6
+
7
+ ### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. **Definitions.**
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. **Grant of Copyright License.** Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. **Grant of Patent License.** Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. **Redistribution.** You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ * **(a)** You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ * **(b)** You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ * **(c)** You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ * **(d)** If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. **Submission of Contributions.** Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. **Trademarks.** This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. **Disclaimer of Warranty.** Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. **Limitation of Liability.** In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. **Accepting Warranty or Additional Liability.** While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ _END OF TERMS AND CONDITIONS_
179
+
180
+ ### APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "`[]`"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ https://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,347 @@
1
+ ## Migrating to google-cloud-talent 0.20
2
+
3
+ The 0.20 release of the google-cloud-talent client is a significant upgrade
4
+ based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
5
+ and includes substantial interface changes. Existing code written for earlier
6
+ versions of this library will likely require updates to use this version.
7
+ This document describes the changes that have been made, and what you need to
8
+ do to update your usage.
9
+
10
+ To summarize:
11
+
12
+ * The library has been broken out into two libraries. The new gem
13
+ `google-cloud-talent-v4beta1` contains the actual client classes for version
14
+ V4beta1 of the Talent service, and the gem `google-cloud-talent` now
15
+ simply provides a convenience wrapper. See
16
+ [Library Structure](#library-structure) for more info.
17
+ * The library uses a new configuration mechanism giving you closer control
18
+ over endpoint address, network timeouts, and retry. See
19
+ [Client Configuration](#client-configuration) for more info. Furthermore,
20
+ when creating a client object, you can customize its configuration in a
21
+ block rather than passing arguments to the constructor. See
22
+ [Creating Clients](#creating-clients) for more info.
23
+ * Previously, positional arguments were used to indicate required arguments.
24
+ Now, all method arguments are keyword arguments, with documentation that
25
+ specifies whether they are required or optional. Additionally, you can pass
26
+ a proto request object instead of separate arguments. See
27
+ [Passing Arguments](#passing-arguments) for more info.
28
+ * Previously, some client classes included class methods for constructing
29
+ resource paths. These paths are now instance methods on the client objects,
30
+ and are also available in a separate paths module. See
31
+ [Resource Path Helpers](#resource-path-helpers) for more info.
32
+ * Previously, clients reported RPC errors by raising instances of
33
+ `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
34
+ `Google::Cloud::Error` and its subclasses. See
35
+ [Handling Errors](#handling-errors) for more info.
36
+ * Some classes have moved into different namespaces. See
37
+ [Class Namespaces](#class-namespaces) for more info.
38
+
39
+ ### Library Structure
40
+
41
+ Older pre-0.20 releases of the `google-cloud-talent` gem were all-in-one gems
42
+ that included potentially multiple clients for multiple versions of the
43
+ Talent service. Factory methods such as `Google::Cloud::Talent::ApplicationService.new`
44
+ would return you instances of client classes such as
45
+ `Google::Cloud::Talent::V4beta1::ApplicationServiceClient`. These classes were all defined
46
+ in the same gem.
47
+
48
+ With the 0.20 release, the `google-cloud-talent` gem still provides factory
49
+ methods for obtaining clients. (The method signatures will have changed. See
50
+ [Creating Clients](#creating-clients) for details.) However, the actual client
51
+ classes have been moved into separate gems, one per service version. Currently,
52
+ Talent has one version, V4beta1. The
53
+ `Google::Cloud::Talent::V4beta1::ApplicationService::Client` class, along with its
54
+ helpers and data types, is now part of the `google-cloud-talent-v4beta1` gem.
55
+
56
+ For normal usage, you can continue to install the `google-cloud-talent` gem
57
+ (which will bring in the versioned client gems as dependencies) and continue to
58
+ use factory methods to create clients. However, you may alternatively choose to
59
+ install only one of the versioned gems. For example, if you know you will only
60
+ use `V4beta1` of the service, you can install `google-cloud-talent-v4beta1` by
61
+ itself, and construct instances of the
62
+ `Google::Cloud::Talent::V4beta1::ApplicationService::Client` client class directly.
63
+
64
+ ### Client Configuration
65
+
66
+ In older releases, if you wanted to customize performance parameters or
67
+ low-level behavior of the client (such as credentials, timeouts, or
68
+ instrumentation), you would pass a variety of keyword arguments to the client
69
+ constructor. It was also extremely difficult to customize the default settings.
70
+
71
+ With the 0.20 release, a configuration interface provides control over these
72
+ parameters, including defaults for all instances of a client, and settings for
73
+ each specific client instance. For example, to set default credentials and
74
+ timeout for all Talent V4beta1 application service clients:
75
+
76
+ ```
77
+ Google::Cloud::Talent::V4beta1::ApplicationService::Client.configure do |config|
78
+ config.credentials = "/path/to/credentials.json"
79
+ config.timeout = 10.0
80
+ end
81
+ ```
82
+
83
+ Individual RPCs can also be configured independently. For example, to set the
84
+ timeout for the `list_applications` call:
85
+
86
+ ```
87
+ Google::Cloud::Talent::V4beta1::ApplicationService::Client.configure do |config|
88
+ config.rpcs.list_applications.timeout = 20.0
89
+ end
90
+ ```
91
+
92
+ Defaults for certain configurations can be set for all Talent versions and
93
+ services globally:
94
+
95
+ ```
96
+ Google::Cloud::Talent.configure do |config|
97
+ config.credentials = "/path/to/credentials.json"
98
+ config.timeout = 10.0
99
+ end
100
+ ```
101
+
102
+ Finally, you can override the configuration for each client instance. See the
103
+ next section on [Creating Clients](#creating-clients) for details.
104
+
105
+ ### Creating Clients
106
+
107
+ In older releases, to create a client object, you would use the `new` method
108
+ of modules under `Google::Cloud::Talent`. For example, you might call
109
+ `Google::Cloud::Talent::ApplicationService.new`. Keyword arguments were available to
110
+ select a service version and to configure parameters such as credentials and
111
+ timeouts.
112
+
113
+ With the 0.20 release, use named class methods of `Google::Cloud::Talent` to
114
+ create a client object. For example, `Google::Cloud::Talent.application_service`.
115
+ You may select a service version using the `:version` keyword argument.
116
+ However, other configuration parameters should be set in a configuration block
117
+ when you create the client.
118
+
119
+ Old:
120
+ ```
121
+ client = Google::Cloud::Talent::ApplicationService.new credentials: "/path/to/credentials.json"
122
+ ```
123
+
124
+ New:
125
+ ```
126
+ client = Google::Cloud::Talent.application_service do |config|
127
+ config.credentials = "/path/to/credentials.json"
128
+ end
129
+ ```
130
+
131
+ The configuration block is optional. If you do not provide it, or you do not
132
+ set some configuration parameters, then the default configuration is used. See
133
+ [Client Configuration](#client-configuration).
134
+
135
+ ### Passing Arguments
136
+
137
+ In older releases, required arguments would be passed as positional method
138
+ arguments, while most optional arguments would be passed as keyword arguments.
139
+
140
+ With the 0.20 release, all RPC arguments are passed as keyword arguments,
141
+ regardless of whether they are required or optional. For example:
142
+
143
+ Old:
144
+ ```
145
+ client = Google::Cloud::Talent::ApplicationService.new
146
+
147
+ parent = "projects/my-project/tenants/my-tenant/profiles/my-profile"
148
+
149
+ # Parent is a positional argument, but page_size is a keyword argument
150
+ response = client.list_applications parent, page_size: 10
151
+ ```
152
+
153
+ New:
154
+ ```
155
+ client = Google::Cloud::Talent.application_service
156
+
157
+ parent = "projects/my-project/tenants/my-tenant/profiles/my-profile"
158
+
159
+ # Parent and page_size are both keyword arguments
160
+ response = client.list_applications parent: parent, page_size: 10
161
+ ```
162
+
163
+ In the 0.20 release, it is also possible to pass a request object, either
164
+ as a hash or as a protocol buffer.
165
+
166
+ New:
167
+ ```
168
+ client = Google::Cloud::Talent.application_service
169
+
170
+ request = Google::Cloud::Talent::V1beta4::ListApplicationsRequest.new(
171
+ parent: "projects/my-project/tenants/my-tenant/profiles/my-profile",
172
+ page_size: 10
173
+ )
174
+
175
+ # Pass a request object as a positional argument:
176
+ response = client.list_applications request
177
+ ```
178
+
179
+ Finally, in older releases, to provide call options, you would pass a
180
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
181
+ 0.20 release, pass call options using a _second set_ of keyword arguments.
182
+
183
+ Old:
184
+ ```
185
+ client = Google::Cloud::Talent::ApplicationService.new
186
+
187
+ parent = "projects/my-project/tenants/my-tenant/profiles/my-profile"
188
+
189
+ options = Google::Gax::CallOptions.new timeout: 10.0
190
+
191
+ response = client.list_applications parent, page_size: 10, options: options
192
+ ```
193
+
194
+ New:
195
+ ```
196
+ client = Google::Cloud::Talent.application_service
197
+
198
+ parent = "projects/my-project/tenants/my-tenant/profiles/my-profile"
199
+
200
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
201
+ # then add further keyword arguments for the call options.
202
+ response = client.list_applications(
203
+ { parent: parent, page_size: 10 },
204
+ timeout: 10.0
205
+ )
206
+ ```
207
+
208
+ ### Resource Path Helpers
209
+
210
+ The client library includes helper methods for generating the resource path
211
+ strings passed to many calls. These helpers have changed in two ways:
212
+
213
+ * In older releases, they are _class_ methods on the client class. In the 0.20
214
+ release, they are _instance_ methods on the client. They are also available
215
+ on a separate paths module that you can include elsewhere for convenience.
216
+ * In older releases, arguments to a resource path helper are passed as
217
+ _positional_ arguments. In the 0.20 release, they are passed as named _keyword_
218
+ arguments. Some helpers also support different sets of arguments, each set
219
+ corresponding to a different type of path.
220
+
221
+ Following is an example involving using a resource path helper.
222
+
223
+ Old:
224
+ ```
225
+ client = Google::Cloud::Talent::ApplicationService.new
226
+
227
+ # Call the helper on the client class
228
+ parent = Google::Cloud::Talent::V1beta4::ApplicationServiceClient.profile_path(
229
+ "my-project", "my-tenant", "my-profile"
230
+ )
231
+
232
+ response = client.list_applications parent, page_size: 10
233
+ ```
234
+
235
+ New:
236
+ ```
237
+ client = Google::Cloud::Talent.application_service
238
+
239
+ # Call the helper on the client instance, and use keyword arguments
240
+ parent = client.profile_path project: "my-project", tenant: "my-tenant",
241
+ profile: "my-profile"
242
+
243
+ response = client.list_applications parent: parent, page_size: 10
244
+ ```
245
+
246
+ Because arguments are passed as keyword arguments, some closely related paths
247
+ have been combined. For example, `job_path` and `job_without_tenant_path` used
248
+ to be separate helpers, one that took a tenant argument and one that did not.
249
+ In the 0.20 client, use `job_path` for both, and either pass or omit the
250
+ `tenant` keyword argument.
251
+
252
+ Old:
253
+ ```
254
+ job1 = Google::Cloud::Talent::V1beta4::ApplicationServiceClient.job_path(
255
+ "my-project", "my-tenant", "my-job"
256
+ )
257
+ job2 = Google::Cloud::Talent::V1beta4::ApplicationServiceClient.job_without_tenant_path(
258
+ "my-project", "my-job"
259
+ )
260
+ ```
261
+
262
+ New:
263
+ ```
264
+ client = Google::Cloud::Talent.application_service
265
+ job1 = client.job_path project: "my-project", tenant: "my-tenant", job: "my-job"
266
+ job2 = client.job_path project: "my-project", job: "my-job"
267
+ ```
268
+
269
+ Finally, in the 0.20 client, you can also use the paths module as a convenience module.
270
+
271
+ New:
272
+ ```
273
+ # Bring the path helper methods into the current class
274
+ include Google::Cloud::Talent::V1beta4::ApplicationService::Paths
275
+
276
+ def foo
277
+ client = Google::Cloud::Talent.application_service
278
+
279
+ # Call the included helper method
280
+ parent = profile_path project: "my-project", tenant: "my-tenant",
281
+ profile: "my-profile"
282
+
283
+ response = client.list_applications parent: parent, page_size: 10
284
+
285
+ # Do something with response...
286
+ end
287
+ ```
288
+
289
+ ### Handling Errors
290
+
291
+ The client reports standard
292
+ [gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
293
+ by raising exceptions. In older releases, these exceptions were located in the
294
+ `Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
295
+ exception class, defined in the `google-gax` gem. However, these classes were
296
+ different from the standard exceptions (subclasses of `Google::Cloud::Error`)
297
+ thrown by other client libraries such as `google-cloud-storage`.
298
+
299
+ The 0.20 client library now uses the `Google::Cloud::Error` exception hierarchy,
300
+ for consistency across all the Google Cloud client libraries. In general, these
301
+ exceptions have the same name as their counterparts from older releases, but
302
+ are located in the `Google::Cloud` namespace rather than the `Google::Gax`
303
+ namespace.
304
+
305
+ Old:
306
+ ```
307
+ client = Google::Cloud::Talent::ApplicationService.new
308
+
309
+ parent = "projects/my-project/tenants/my-tenant/profiles/my-profile"
310
+
311
+ begin
312
+ response = client.list_applications parent, page_size: 10
313
+ rescue Google::Gax::Error => e
314
+ # Handle exceptions that subclass Google::Gax::Error
315
+ end
316
+ ```
317
+
318
+ New:
319
+ ```
320
+ client = Google::Cloud::Talent.application_service
321
+
322
+ parent = "projects/my-project/tenants/my-tenant/profiles/my-profile"
323
+
324
+ begin
325
+ response = client.list_applications parent: parent, page_size: 10
326
+ rescue Google::Cloud::Error => e
327
+ # Handle exceptions that subclass Google::Cloud::Error
328
+ end
329
+ ```
330
+
331
+ ### Class Namespaces
332
+
333
+ In older releases, the client object was of classes with names like:
334
+ `Google::Cloud::Talent::V1beta4::ApplicationServiceClient`.
335
+ In the 0.20 release, the client object is of a different class:
336
+ `Google::Cloud::Talent::V1beta4::ApplicationService::Client`.
337
+ Note that most users will use the factory methods such as
338
+ `Google::Cloud::Talent.application_service` to create instances of the client object,
339
+ so you may not need to reference the actual class directly.
340
+ See [Creating Clients](#creating-clients).
341
+
342
+ In older releases, the credentials object was of class
343
+ `Google::Cloud::Talent::V1beta4::Credentials`.
344
+ In the 0.20 release, each service has its own credentials class, e.g.
345
+ `Google::Cloud::Talent::V1beta4::ApplicationService::Credentials`.
346
+ Again, most users will not need to reference this class directly.
347
+ See [Client Configuration](#client-configuration).