google-cloud-scheduler 1.3.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -54
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +275 -0
  6. data/README.md +36 -24
  7. data/lib/{google/cloud/scheduler/v1/doc/google/protobuf/empty.rb → google-cloud-scheduler.rb} +4 -14
  8. data/lib/google/cloud/scheduler.rb +82 -117
  9. data/lib/google/cloud/scheduler/version.rb +6 -2
  10. metadata +102 -73
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/scheduler/v1.rb +0 -147
  13. data/lib/google/cloud/scheduler/v1/cloud_scheduler_client.rb +0 -616
  14. data/lib/google/cloud/scheduler/v1/cloud_scheduler_client_config.json +0 -66
  15. data/lib/google/cloud/scheduler/v1/cloudscheduler_pb.rb +0 -65
  16. data/lib/google/cloud/scheduler/v1/cloudscheduler_services_pb.rb +0 -84
  17. data/lib/google/cloud/scheduler/v1/credentials.rb +0 -41
  18. data/lib/google/cloud/scheduler/v1/doc/google/cloud/scheduler/v1/cloudscheduler.rb +0 -124
  19. data/lib/google/cloud/scheduler/v1/doc/google/cloud/scheduler/v1/job.rb +0 -219
  20. data/lib/google/cloud/scheduler/v1/doc/google/cloud/scheduler/v1/target.rb +0 -336
  21. data/lib/google/cloud/scheduler/v1/doc/google/protobuf/any.rb +0 -131
  22. data/lib/google/cloud/scheduler/v1/doc/google/protobuf/duration.rb +0 -91
  23. data/lib/google/cloud/scheduler/v1/doc/google/protobuf/field_mask.rb +0 -222
  24. data/lib/google/cloud/scheduler/v1/doc/google/protobuf/timestamp.rb +0 -113
  25. data/lib/google/cloud/scheduler/v1/doc/google/rpc/status.rb +0 -39
  26. data/lib/google/cloud/scheduler/v1/helpers.rb +0 -48
  27. data/lib/google/cloud/scheduler/v1/job_pb.rb +0 -58
  28. data/lib/google/cloud/scheduler/v1/target_pb.rb +0 -72
  29. data/lib/google/cloud/scheduler/v1beta1.rb +0 -147
  30. data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler_client.rb +0 -613
  31. data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler_client_config.json +0 -66
  32. data/lib/google/cloud/scheduler/v1beta1/cloudscheduler_pb.rb +0 -65
  33. data/lib/google/cloud/scheduler/v1beta1/cloudscheduler_services_pb.rb +0 -84
  34. data/lib/google/cloud/scheduler/v1beta1/credentials.rb +0 -41
  35. data/lib/google/cloud/scheduler/v1beta1/doc/google/cloud/scheduler/v1beta1/cloudscheduler.rb +0 -124
  36. data/lib/google/cloud/scheduler/v1beta1/doc/google/cloud/scheduler/v1beta1/job.rb +0 -221
  37. data/lib/google/cloud/scheduler/v1beta1/doc/google/cloud/scheduler/v1beta1/target.rb +0 -336
  38. data/lib/google/cloud/scheduler/v1beta1/doc/google/protobuf/any.rb +0 -131
  39. data/lib/google/cloud/scheduler/v1beta1/doc/google/protobuf/duration.rb +0 -91
  40. data/lib/google/cloud/scheduler/v1beta1/doc/google/protobuf/empty.rb +0 -29
  41. data/lib/google/cloud/scheduler/v1beta1/doc/google/protobuf/field_mask.rb +0 -222
  42. data/lib/google/cloud/scheduler/v1beta1/doc/google/protobuf/timestamp.rb +0 -113
  43. data/lib/google/cloud/scheduler/v1beta1/doc/google/rpc/status.rb +0 -39
  44. data/lib/google/cloud/scheduler/v1beta1/helpers.rb +0 -48
  45. data/lib/google/cloud/scheduler/v1beta1/job_pb.rb +0 -58
  46. data/lib/google/cloud/scheduler/v1beta1/target_pb.rb +0 -72
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fb2e1900322d96e1a75c2962493a166c5b21592aa9a65ba49a425ae56c1b219d
4
- data.tar.gz: 3ff11315fd5c6750a6e3304453948030acf91150f78509466e72fcc49c397461
3
+ metadata.gz: 2c6303660b2f4115dd0a712618f226a0dd41b947e30382a4b0ad6a3833161e45
4
+ data.tar.gz: a09191b2d6242b3dafd11800f40207832178e023b121e03fb0af786f812b8960
5
5
  SHA512:
6
- metadata.gz: '0486600b23d8fd047ad34f61feae87277f8e2ac06770fc7487cd7326f0b25feddb1a227b6522e1062acc781dd31321306db4efc7acca995f1904236040ea4af1'
7
- data.tar.gz: 1f0fcaf820cf9af51f02e8c3632670f916d4707da822a794ccb1f05e159fa43bdb64413e9c954d03a32c67dc3ec1e354f288062e25dc1e438525264ff2967e9a
6
+ metadata.gz: 12c28fae62e19765dd8042e54806e2eda5ba02a0b0ce896fbff7de81f1529cce2bb76846f706e7c8189325e269fa323df1327fbc6ed31b0a535e460dce5d42da
7
+ data.tar.gz: 8cf1dff4079ede20c0afaae113e6eb52ff401a2ef84deb534fb6b8541dd1a6922e112b6c0bff8c661123912e6ad0a5bd220342bdfd053a5c42a9e7812d508f5b
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
data/AUTHENTICATION.md CHANGED
@@ -1,16 +1,17 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-scheduler 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-scheduler 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 SCHEDULER_CREDENTIALS=/path/to/json`
22
+ export SCHEDULER_CREDENTIALS=path/to/keyfile.json
22
23
  ```
23
24
 
24
25
  3. Initialize the client.
@@ -26,23 +27,14 @@ export SCHEDULER_CREDENTIALS=/path/to/json`
26
27
  ```ruby
27
28
  require "google/cloud/scheduler"
28
29
 
29
- client = Google::Cloud::Scheduler.new
30
+ client = Google::Cloud::Scheduler.cloud_scheduler
30
31
  ```
31
32
 
32
- ## Project and Credential Lookup
33
+ ## Credential Lookup
33
34
 
34
35
  The google-cloud-scheduler 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-scheduler checks for project ID are:
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.
75
64
 
76
- 1. `SCHEDULER_PROJECT`
77
- 2. `GOOGLE_CLOUD_PROJECT`
78
-
79
- The environment variables that google-cloud-scheduler checks for credentials are configured on {Google::Cloud::Scheduler::V1::Credentials}:
65
+ The environment variables that google-cloud-scheduler
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::Scheduler::V1::CloudScheduler::Credentials`):
80
68
 
81
69
  1. `SCHEDULER_CREDENTIALS` - Path to JSON file, or JSON contents
82
70
  2. `SCHEDULER_KEYFILE` - Path to JSON file, or JSON contents
@@ -87,25 +75,34 @@ The environment variables that google-cloud-scheduler checks for credentials are
87
75
  ```ruby
88
76
  require "google/cloud/scheduler"
89
77
 
90
- ENV["SCHEDULER_PROJECT"] = "my-project-id"
91
78
  ENV["SCHEDULER_CREDENTIALS"] = "path/to/keyfile.json"
92
79
 
93
- client = Google::Cloud::Scheduler.new
80
+ client = Google::Cloud::Scheduler.cloud_scheduler
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/scheduler"
90
+
91
+ client = Google::Cloud::Scheduler.cloud_scheduler 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/scheduler"
102
100
 
103
101
  Google::Cloud::Scheduler.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::Scheduler.new
105
+ client = Google::Cloud::Scheduler.cloud_scheduler
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-scheduler.
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
 
data/LICENSE.md ADDED
@@ -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.
data/MIGRATING.md ADDED
@@ -0,0 +1,275 @@
1
+ ## Migrating to google-cloud-scheduler 2.0
2
+
3
+ The 2.0 release of the google-cloud-scheduler 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 three libraries. The new gems
13
+ `google-cloud-scheduler-v1` and `google-cloud-scheduler-v1beta1` contain the
14
+ actual client classes for versions V1 and V1beta1 of the Cloud Scheduler
15
+ service, and the gem `google-cloud-scheduler` now simply provides a
16
+ convenience wrapper. See [Library Structure](#library-structure) for more
17
+ info.
18
+ * The library uses a new configuration mechanism giving you closer control
19
+ over endpoint address, network timeouts, and retry. See
20
+ [Client Configuration](#client-configuration) for more info. Furthermore,
21
+ when creating a client object, you can customize its configuration in a
22
+ block rather than passing arguments to the constructor. See
23
+ [Creating Clients](#creating-clients) for more info.
24
+ * Previously, positional arguments were used to indicate required arguments.
25
+ Now, all method arguments are keyword arguments, with documentation that
26
+ specifies whether they are required or optional. Additionally, you can pass
27
+ a proto request object instead of separate arguments. See
28
+ [Passing Arguments](#passing-arguments) for more info.
29
+ * Previously, some client classes included helper methods for constructing
30
+ resource paths. These methods now take keyword rather than positional
31
+ arguments, and are also available in a separate paths module. See
32
+ [Resource Path Helpers](#resource-path-helpers) for more info.
33
+ * Some classes have moved into different namespaces. See
34
+ [Class Namespaces](#class-namespaces) for more info.
35
+
36
+ ### Library Structure
37
+
38
+ Older 1.x releases of the `google-cloud-scheduler` gem were all-in-one gems that
39
+ included potentially multiple clients for multiple versions of the Cloud
40
+ Scheduler service. The `Google::Cloud::Scheduler.new` factory method would
41
+ return you an instance of a `Google::Cloud::Scheduler::V1::CloudSchedulerClient`
42
+ object for the V1 version of the service, or a
43
+ `Google::Cloud::Scheduler::V1beta1::CloudSchedulerClient` object for the
44
+ V1beta1 version of the service. All these classes were defined in the same gem.
45
+
46
+ With the 2.0 release, the `google-cloud-scheduler` gem still provides factory
47
+ methods for obtaining clients. (The method signatures will have changed. See
48
+ [Creating Clients](#creating-clients) for details.) However, the actual client
49
+ classes have been moved into separate gems, one per service version. The
50
+ `Google::Cloud::Scheduler::V1::CloudScheduler::Client` class, along with its
51
+ helpers and data types, is now part of the `google-cloud-scheduler-v1` gem.
52
+ Similarly, the `Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client`
53
+ class is part of the `google-cloud-scheduler-v1beta1` gem.
54
+
55
+ For normal usage, you can continue to install the `google-cloud-scheduler` gem
56
+ (which will bring in the versioned client gems as dependencies) and continue to
57
+ use factory methods to create clients. However, you may alternatively choose to
58
+ install only one of the versioned gems. For example, if you know you will use only
59
+ `V1` of the service, you can install `google-cloud-scheduler-v1` by itself, and
60
+ construct instances of the
61
+ `Google::Cloud::Scheduler::V1::CloudScheduler::Client` client class directly.
62
+
63
+ ### Client Configuration
64
+
65
+ In older releases, if you wanted to customize performance parameters or
66
+ low-level behavior of the client (such as credentials, timeouts, or
67
+ instrumentation), you would pass a variety of keyword arguments to the client
68
+ constructor. It was also extremely difficult to customize the default settings.
69
+
70
+ With the 2.0 release, a configuration interface provides control over these
71
+ parameters, including defaults for all instances of a client, and settings for
72
+ each specific client instance. For example, to set default credentials and
73
+ timeout for all Cloud Scheduler V1 clients:
74
+
75
+ ```
76
+ Google::Cloud::Scheduler::V1::CloudScheduler::Client.configure do |config|
77
+ config.credentials = "/path/to/credentials.json"
78
+ config.timeout = 10.0
79
+ end
80
+ ```
81
+
82
+ Individual RPCs can also be configured independently. For example, to set the
83
+ timeout for the `list_jobs` call:
84
+
85
+ ```
86
+ Google::Cloud::Scheduler::V1::CloudScheduler::Client.configure do |config|
87
+ config.rpcs.list_jobs.timeout = 20.0
88
+ end
89
+ ```
90
+
91
+ Defaults for certain configurations can be set for all Scheduler versions
92
+ globally:
93
+
94
+ ```
95
+ Google::Cloud::Scheduler.configure do |config|
96
+ config.credentials = "/path/to/credentials.json"
97
+ config.timeout = 10.0
98
+ end
99
+ ```
100
+
101
+ Finally, you can override the configuration for each client instance. See the
102
+ next section on [Creating Clients](#creating-clients) for details.
103
+
104
+ ### Creating Clients
105
+
106
+ In older releases, to create a client object, you would use the
107
+ `Google::Cloud::Scheduler.new` class method. Keyword arguments were available to
108
+ select a service version and to configure parameters such as credentials and
109
+ timeouts.
110
+
111
+ With the 2.0 release, use the `Google::Cloud::Scheduler.cloud_scheduler` class
112
+ method to create a client object. You may select a service version using the
113
+ `:version` keyword argument. However, other configuration parameters should be
114
+ set in a configuration block when you create the client.
115
+
116
+ Old:
117
+ ```
118
+ client = Google::Cloud::Scheduler.new credentials: "/path/to/credentials.json"
119
+ ```
120
+
121
+ New:
122
+ ```
123
+ client = Google::Cloud::Scheduler.cloud_scheduler do |config|
124
+ config.credentials = "/path/to/credentials.json"
125
+ end
126
+ ```
127
+
128
+ The configuration block is optional. If you do not provide it, or you do not
129
+ set some configuration parameters, then the default configuration is used. See
130
+ [Client Configuration](#client-configuration).
131
+
132
+ ### Passing Arguments
133
+
134
+ In older releases, required arguments would be passed as positional method
135
+ arguments, while most optional arguments would be passed as keyword arguments.
136
+
137
+ With the 2.0 release, all RPC arguments are passed as keyword arguments,
138
+ regardless of whether they are required or optional. For example:
139
+
140
+ Old:
141
+ ```
142
+ client = Google::Cloud::Scheduler.new
143
+
144
+ parent = "projects/my-project/locations/-"
145
+
146
+ # Parent is a positional argument, while page_size is a keyword argument.
147
+ response = client.list_jobs parent, page_size: 10
148
+ ```
149
+
150
+ New:
151
+ ```
152
+ client = Google::Cloud::Scheduler.cloud_scheduler
153
+
154
+ parent = "projects/my-project/locations/-"
155
+
156
+ # Both parent and page_size are keyword arguments.
157
+ response = client.list_jobs parent: parent, page_size: 10
158
+ ```
159
+
160
+ In the 2.0 release, it is also possible to pass a request object, either
161
+ as a hash or as a protocol buffer.
162
+
163
+ New:
164
+ ```
165
+ client = Google::Cloud::Scheduler.cloud_scheduler
166
+
167
+ request = Google::Cloud::Scheduler::V1::ListJobsRequest.new(
168
+ parent: "projects/my-project/locations/-",
169
+ page_size: 10
170
+ )
171
+
172
+ # Pass a request object as a positional argument:
173
+ response = client.list_jobs request
174
+ ```
175
+
176
+ Finally, in older releases, to provide call options, you would pass a
177
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
178
+ 2.0 release, pass call options using a _second set_ of keyword arguments.
179
+
180
+ Old:
181
+ ```
182
+ client = Google::Cloud::Scheduler.new
183
+
184
+ parent = "projects/my-project/locations/-"
185
+
186
+ options = Google::Gax::CallOptions.new timeout: 10.0
187
+
188
+ response = client.list_jobs parent, page_size: 10, options: options
189
+ ```
190
+
191
+ New:
192
+ ```
193
+ client = Google::Cloud::Scheduler.cloud_scheduler
194
+
195
+ parent = "projects/my-project/locations/-"
196
+
197
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
198
+ # then add further keyword arguments for the call options.
199
+ response = client.list_jobs(
200
+ { parent: parent, page_size: 10 },
201
+ timeout: 10.0
202
+ )
203
+ ```
204
+
205
+ ### Resource Path Helpers
206
+
207
+ The client library includes helper methods for generating the resource path
208
+ strings passed to many calls. These helpers have changed in two ways:
209
+
210
+ * In older releases, they are both _class_ methods and _instance_ methods on
211
+ the client class. In the 2.0 release, they are _instance methods only_.
212
+ However, they are also available on a separate paths module that you can
213
+ include elsewhere for convenience.
214
+ * In older releases, arguments to a resource path helper are passed as
215
+ _positional_ arguments. In the 2.0 release, they are passed as named _keyword_
216
+ arguments.
217
+
218
+ Following is an example involving using a resource path helper.
219
+
220
+ Old:
221
+ ```
222
+ client = Google::Cloud::Scheduler.new
223
+
224
+ # Call the helper using positional arguments.
225
+ parent = client.location_path "my-project", "-"
226
+
227
+ response = client.list_jobs parent
228
+ ```
229
+
230
+ New:
231
+ ```
232
+ client = Google::Cloud::Scheduler.cloud_scheduler
233
+
234
+ # Call the helper using keyword arguments
235
+ parent = client.location_path project: "my-project", location: "-"
236
+
237
+ response = client.list_jobs parent: parent
238
+ ```
239
+
240
+ In the 2.0 client, you can also use the paths module as a convenience module.
241
+
242
+ New:
243
+ ```
244
+ # Bring the session_path method into the current class
245
+ include Google::Cloud::Scheduler::V1::CloudScheduler::Paths
246
+
247
+ def foo
248
+ client = Google::Cloud::Scheduler.cloud_scheduler
249
+
250
+ # Call the included helper method
251
+ parent = location_path project: "my-project", location: "-"
252
+
253
+ response = client.list_jobs parent: parent
254
+
255
+ # Do something with response...
256
+ end
257
+ ```
258
+
259
+ ### Class Namespaces
260
+
261
+ In older releases, the client object was of class
262
+ `Google::Cloud::Scheduler::V1::CloudSchedulerClient`.
263
+ In the 2.0 release, the client object is of class
264
+ `Google::Cloud::Scheduler::V1::CloudScheduler::Client`.
265
+ Note that most users will use the `Google::Cloud::Scheduler.cloud_scheduler`
266
+ factory method to create instances of the client object, so you may not need to
267
+ reference the actual class directly.
268
+ See [Creating Clients](#creating-clients).
269
+
270
+ In older releases, the credentials object was of class
271
+ `Google::Cloud::Scheduler::V1::Credentials`.
272
+ In the 2.0 release, the credentials object is of class
273
+ `Google::Cloud::Scheduler::V1::CloudScheduler::Credentials`.
274
+ Again, most users will not need to reference this class directly.
275
+ See [Client Configuration](#client-configuration).