google-apis-cloudscheduler_v1beta1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-cloudscheduler_v1beta1.rb +15 -0
- data/lib/google/apis/cloudscheduler_v1beta1.rb +36 -0
- data/lib/google/apis/cloudscheduler_v1beta1/classes.rb +850 -0
- data/lib/google/apis/cloudscheduler_v1beta1/gem_version.rb +28 -0
- data/lib/google/apis/cloudscheduler_v1beta1/representations.rb +300 -0
- data/lib/google/apis/cloudscheduler_v1beta1/service.rb +436 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 2036658a50e49e7af366ee189ad2abf17acf85d3e5e68914f4f01ac5a1f3083f
|
4
|
+
data.tar.gz: 256decddbdf3cac0b280e0569bc2f9323080563ebe507f3bf58a212c4495b51d
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 6ef5fc2f7cda80708308240edec14d02514bdc70ad7d528ad549cbdd05816271efc4fae9d1a2f119d0f5e383f15e732e02015d9121ba3fb8f63221f9cb222f9d
|
7
|
+
data.tar.gz: e7fe1eff3e9b29e08d71af09791f42c68d0ffb987c00e5d67147896794f4a7c92bd98517a2fa79de9d9742c12f2ab18205a92f9d3ae473f47a4292a10586a7ee
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-cloudscheduler_v1beta1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/cloudscheduler_v1beta1/*.rb
|
9
|
+
lib/google/apis/cloudscheduler_v1beta1.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1beta1 of the Cloud Scheduler API
|
2
|
+
|
3
|
+
This is a simple client library for version V1beta1 of the Cloud Scheduler API. It provides:
|
4
|
+
|
5
|
+
* A client object that connects to the HTTP/JSON REST endpoint for the service.
|
6
|
+
* Ruby objects for data structures related to the service.
|
7
|
+
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
|
8
|
+
* Control of retry, pagination, and timeouts.
|
9
|
+
|
10
|
+
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
|
11
|
+
|
12
|
+
## Getting started
|
13
|
+
|
14
|
+
### Before you begin
|
15
|
+
|
16
|
+
There are a few setup steps you need to complete before you can use this library:
|
17
|
+
|
18
|
+
1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
|
19
|
+
2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
|
20
|
+
3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/cloudscheduler.googleapis.com) in the console.
|
21
|
+
|
22
|
+
### Installation
|
23
|
+
|
24
|
+
Add this line to your application's Gemfile:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
gem 'google-apis-cloudscheduler_v1beta1', '~> 0.1'
|
28
|
+
```
|
29
|
+
|
30
|
+
And then execute:
|
31
|
+
|
32
|
+
```
|
33
|
+
$ bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
Or install it yourself as:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install google-apis-cloudscheduler_v1beta1
|
40
|
+
```
|
41
|
+
|
42
|
+
### Creating a client object
|
43
|
+
|
44
|
+
Once the gem is installed, you can load the client code and instantiate a client.
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
# Load the client
|
48
|
+
require "google/apis/cloudscheduler_v1beta1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::CloudschedulerV1beta1::CloudSchedulerService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authentication = # ... use the googleauth gem to create credentials
|
55
|
+
```
|
56
|
+
|
57
|
+
See the class reference docs for information on the methods you can call from a client.
|
58
|
+
|
59
|
+
## Documentation
|
60
|
+
|
61
|
+
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
|
+
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
65
|
+
|
66
|
+
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Cloudscheduler service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Cloud Scheduler API, see the {Google::Apis::CloudschedulerV1beta1::CloudSchedulerService class reference docs}.
|
69
|
+
|
70
|
+
## Which client should I use?
|
71
|
+
|
72
|
+
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
|
73
|
+
|
74
|
+
This library, `google-apis-cloudscheduler_v1beta1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://cloud.google.com/scheduler/) may provide guidance regarding the preferred client library to use.
|
83
|
+
|
84
|
+
## Supported Ruby versions
|
85
|
+
|
86
|
+
This library is supported on Ruby 2.5+.
|
87
|
+
|
88
|
+
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
|
93
|
+
|
94
|
+
## Support
|
95
|
+
|
96
|
+
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "google/apis/cloudscheduler_v1beta1"
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/cloudscheduler_v1beta1/service.rb'
|
16
|
+
require 'google/apis/cloudscheduler_v1beta1/classes.rb'
|
17
|
+
require 'google/apis/cloudscheduler_v1beta1/representations.rb'
|
18
|
+
require 'google/apis/cloudscheduler_v1beta1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Cloud Scheduler API
|
23
|
+
#
|
24
|
+
# Creates and manages jobs run on a regular recurring schedule.
|
25
|
+
#
|
26
|
+
# @see https://cloud.google.com/scheduler/
|
27
|
+
module CloudschedulerV1beta1
|
28
|
+
# Version of the Cloud Scheduler API this client connects to.
|
29
|
+
# This is NOT the gem version.
|
30
|
+
VERSION = 'V1beta1'
|
31
|
+
|
32
|
+
# View and manage your data across Google Cloud Platform services
|
33
|
+
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,850 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'date'
|
16
|
+
require 'google/apis/core/base_service'
|
17
|
+
require 'google/apis/core/json_representation'
|
18
|
+
require 'google/apis/core/hashable'
|
19
|
+
require 'google/apis/errors'
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Apis
|
23
|
+
module CloudschedulerV1beta1
|
24
|
+
|
25
|
+
# App Engine target. The job will be pushed to a job handler by means of an HTTP
|
26
|
+
# request via an http_method such as HTTP POST, HTTP GET, etc. The job is
|
27
|
+
# acknowledged by means of an HTTP response code in the range [200 - 299]. Error
|
28
|
+
# 503 is considered an App Engine system error instead of an application error.
|
29
|
+
# Requests returning error 503 will be retried regardless of retry configuration
|
30
|
+
# and not counted against retry counts. Any other response code, or a failure to
|
31
|
+
# receive a response before the deadline, constitutes a failed attempt.
|
32
|
+
class AppEngineHttpTarget
|
33
|
+
include Google::Apis::Core::Hashable
|
34
|
+
|
35
|
+
# App Engine Routing. For more information about services, versions, and
|
36
|
+
# instances see [An Overview of App Engine](https://cloud.google.com/appengine/
|
37
|
+
# docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
|
38
|
+
# App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-
|
39
|
+
# app-engine), [App Engine Standard request routing](https://cloud.google.com/
|
40
|
+
# appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex
|
41
|
+
# request routing](https://cloud.google.com/appengine/docs/flexible/python/how-
|
42
|
+
# requests-are-routed).
|
43
|
+
# Corresponds to the JSON property `appEngineRouting`
|
44
|
+
# @return [Google::Apis::CloudschedulerV1beta1::AppEngineRouting]
|
45
|
+
attr_accessor :app_engine_routing
|
46
|
+
|
47
|
+
# Body. HTTP request body. A request body is allowed only if the HTTP method is
|
48
|
+
# POST or PUT. It will result in invalid argument error to set a body on a job
|
49
|
+
# with an incompatible HttpMethod.
|
50
|
+
# Corresponds to the JSON property `body`
|
51
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
52
|
+
# @return [String]
|
53
|
+
attr_accessor :body
|
54
|
+
|
55
|
+
# HTTP request headers. This map contains the header field names and values.
|
56
|
+
# Headers can be set when the job is created. Cloud Scheduler sets some headers
|
57
|
+
# to default values: * `User-Agent`: By default, this header is `"AppEngine-
|
58
|
+
# Google; (+http://code.google.com/appengine)"`. This header can be modified,
|
59
|
+
# but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/
|
60
|
+
# appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header
|
61
|
+
# will be set to true. If the job has an body, Cloud Scheduler sets the
|
62
|
+
# following headers: * `Content-Type`: By default, the `Content-Type` header is
|
63
|
+
# set to `"application/octet-stream"`. The default can be overridden by
|
64
|
+
# explictly setting `Content-Type` to a particular media type when the job is
|
65
|
+
# created. For example, `Content-Type` can be set to `"application/json"`. * `
|
66
|
+
# Content-Length`: This is computed by Cloud Scheduler. This value is output
|
67
|
+
# only. It cannot be changed. The headers below are output only. They cannot be
|
68
|
+
# set or overridden: * `X-Google-*`: For Google internal use only. * `X-
|
69
|
+
# AppEngine-*`: For Google internal use only. In addition, some App Engine
|
70
|
+
# headers, which contain job-specific information, are also be sent to the job
|
71
|
+
# handler.
|
72
|
+
# Corresponds to the JSON property `headers`
|
73
|
+
# @return [Hash<String,String>]
|
74
|
+
attr_accessor :headers
|
75
|
+
|
76
|
+
# The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
|
77
|
+
# Corresponds to the JSON property `httpMethod`
|
78
|
+
# @return [String]
|
79
|
+
attr_accessor :http_method
|
80
|
+
|
81
|
+
# The relative URI. The relative URL must begin with "/" and must be a valid
|
82
|
+
# HTTP relative URL. It can contain a path, query string arguments, and `#`
|
83
|
+
# fragments. If the relative URL is empty, then the root path "/" will be used.
|
84
|
+
# No spaces are allowed, and the maximum length allowed is 2083 characters.
|
85
|
+
# Corresponds to the JSON property `relativeUri`
|
86
|
+
# @return [String]
|
87
|
+
attr_accessor :relative_uri
|
88
|
+
|
89
|
+
def initialize(**args)
|
90
|
+
update!(**args)
|
91
|
+
end
|
92
|
+
|
93
|
+
# Update properties of this object
|
94
|
+
def update!(**args)
|
95
|
+
@app_engine_routing = args[:app_engine_routing] if args.key?(:app_engine_routing)
|
96
|
+
@body = args[:body] if args.key?(:body)
|
97
|
+
@headers = args[:headers] if args.key?(:headers)
|
98
|
+
@http_method = args[:http_method] if args.key?(:http_method)
|
99
|
+
@relative_uri = args[:relative_uri] if args.key?(:relative_uri)
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
# App Engine Routing. For more information about services, versions, and
|
104
|
+
# instances see [An Overview of App Engine](https://cloud.google.com/appengine/
|
105
|
+
# docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
|
106
|
+
# App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-
|
107
|
+
# app-engine), [App Engine Standard request routing](https://cloud.google.com/
|
108
|
+
# appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex
|
109
|
+
# request routing](https://cloud.google.com/appengine/docs/flexible/python/how-
|
110
|
+
# requests-are-routed).
|
111
|
+
class AppEngineRouting
|
112
|
+
include Google::Apis::Core::Hashable
|
113
|
+
|
114
|
+
# Output only. The host that the job is sent to. For more information about how
|
115
|
+
# App Engine requests are routed, see [here](https://cloud.google.com/appengine/
|
116
|
+
# docs/standard/python/how-requests-are-routed). The host is constructed as: * `
|
117
|
+
# host = [application_domain_name]` `| [service] + '.' + [
|
118
|
+
# application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [
|
119
|
+
# version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [
|
120
|
+
# application_domain_name]` `| [instance_dot_service] + '.' + [
|
121
|
+
# application_domain_name]` `| [instance_dot_version] + '.' + [
|
122
|
+
# application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [
|
123
|
+
# application_domain_name]` * `application_domain_name` = The domain name of the
|
124
|
+
# app, for example .appspot.com, which is associated with the job's project ID. *
|
125
|
+
# `service =` service * `version =` version * `version_dot_service =` version `+
|
126
|
+
# '.' +` service * `instance =` instance * `instance_dot_service =` instance `+
|
127
|
+
# '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `
|
128
|
+
# instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +`
|
129
|
+
# service If service is empty, then the job will be sent to the service which is
|
130
|
+
# the default service when the job is attempted. If version is empty, then the
|
131
|
+
# job will be sent to the version which is the default version when the job is
|
132
|
+
# attempted. If instance is empty, then the job will be sent to an instance
|
133
|
+
# which is available when the job is attempted. If service, version, or instance
|
134
|
+
# is invalid, then the job will be sent to the default version of the default
|
135
|
+
# service when the job is attempted.
|
136
|
+
# Corresponds to the JSON property `host`
|
137
|
+
# @return [String]
|
138
|
+
attr_accessor :host
|
139
|
+
|
140
|
+
# App instance. By default, the job is sent to an instance which is available
|
141
|
+
# when the job is attempted. Requests can only be sent to a specific instance if
|
142
|
+
# [manual scaling is used in App Engine Standard](https://cloud.google.com/
|
143
|
+
# appengine/docs/python/an-overview-of-app-engine?hl=en_US#
|
144
|
+
# scaling_types_and_instance_classes). App Engine Flex does not support
|
145
|
+
# instances. For more information, see [App Engine Standard request routing](
|
146
|
+
# https://cloud.google.com/appengine/docs/standard/python/how-requests-are-
|
147
|
+
# routed) and [App Engine Flex request routing](https://cloud.google.com/
|
148
|
+
# appengine/docs/flexible/python/how-requests-are-routed).
|
149
|
+
# Corresponds to the JSON property `instance`
|
150
|
+
# @return [String]
|
151
|
+
attr_accessor :instance
|
152
|
+
|
153
|
+
# App service. By default, the job is sent to the service which is the default
|
154
|
+
# service when the job is attempted.
|
155
|
+
# Corresponds to the JSON property `service`
|
156
|
+
# @return [String]
|
157
|
+
attr_accessor :service
|
158
|
+
|
159
|
+
# App version. By default, the job is sent to the version which is the default
|
160
|
+
# version when the job is attempted.
|
161
|
+
# Corresponds to the JSON property `version`
|
162
|
+
# @return [String]
|
163
|
+
attr_accessor :version
|
164
|
+
|
165
|
+
def initialize(**args)
|
166
|
+
update!(**args)
|
167
|
+
end
|
168
|
+
|
169
|
+
# Update properties of this object
|
170
|
+
def update!(**args)
|
171
|
+
@host = args[:host] if args.key?(:host)
|
172
|
+
@instance = args[:instance] if args.key?(:instance)
|
173
|
+
@service = args[:service] if args.key?(:service)
|
174
|
+
@version = args[:version] if args.key?(:version)
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
178
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
179
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
180
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
181
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
182
|
+
# `Empty` is empty JSON object ````.
|
183
|
+
class Empty
|
184
|
+
include Google::Apis::Core::Hashable
|
185
|
+
|
186
|
+
def initialize(**args)
|
187
|
+
update!(**args)
|
188
|
+
end
|
189
|
+
|
190
|
+
# Update properties of this object
|
191
|
+
def update!(**args)
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
# Http target. The job will be pushed to the job handler by means of an HTTP
|
196
|
+
# request via an http_method such as HTTP POST, HTTP GET, etc. The job is
|
197
|
+
# acknowledged by means of an HTTP response code in the range [200 - 299]. A
|
198
|
+
# failure to receive a response constitutes a failed execution. For a redirected
|
199
|
+
# request, the response returned by the redirected request is considered.
|
200
|
+
class HttpTarget
|
201
|
+
include Google::Apis::Core::Hashable
|
202
|
+
|
203
|
+
# HTTP request body. A request body is allowed only if the HTTP method is POST,
|
204
|
+
# PUT, or PATCH. It is an error to set body on a job with an incompatible
|
205
|
+
# HttpMethod.
|
206
|
+
# Corresponds to the JSON property `body`
|
207
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
208
|
+
# @return [String]
|
209
|
+
attr_accessor :body
|
210
|
+
|
211
|
+
# The user can specify HTTP request headers to send with the job's HTTP request.
|
212
|
+
# This map contains the header field names and values. Repeated headers are not
|
213
|
+
# supported, but a header value can contain commas. These headers represent a
|
214
|
+
# subset of the headers that will accompany the job's HTTP request. Some HTTP
|
215
|
+
# request headers will be ignored or replaced. A partial list of headers that
|
216
|
+
# will be ignored or replaced is below: - Host: This will be computed by Cloud
|
217
|
+
# Scheduler and derived from uri. * `Content-Length`: This will be computed by
|
218
|
+
# Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`
|
219
|
+
# . * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal
|
220
|
+
# use only. The total size of headers must be less than 80KB.
|
221
|
+
# Corresponds to the JSON property `headers`
|
222
|
+
# @return [Hash<String,String>]
|
223
|
+
attr_accessor :headers
|
224
|
+
|
225
|
+
# Which HTTP method to use for the request.
|
226
|
+
# Corresponds to the JSON property `httpMethod`
|
227
|
+
# @return [String]
|
228
|
+
attr_accessor :http_method
|
229
|
+
|
230
|
+
# Contains information needed for generating an [OAuth token](https://developers.
|
231
|
+
# google.com/identity/protocols/OAuth2). This type of authorization should
|
232
|
+
# generally only be used when calling Google APIs hosted on *.googleapis.com.
|
233
|
+
# Corresponds to the JSON property `oauthToken`
|
234
|
+
# @return [Google::Apis::CloudschedulerV1beta1::OAuthToken]
|
235
|
+
attr_accessor :oauth_token
|
236
|
+
|
237
|
+
# Contains information needed for generating an [OpenID Connect token](https://
|
238
|
+
# developers.google.com/identity/protocols/OpenIDConnect). This type of
|
239
|
+
# authorization can be used for many scenarios, including calling Cloud Run, or
|
240
|
+
# endpoints where you intend to validate the token yourself.
|
241
|
+
# Corresponds to the JSON property `oidcToken`
|
242
|
+
# @return [Google::Apis::CloudschedulerV1beta1::OidcToken]
|
243
|
+
attr_accessor :oidc_token
|
244
|
+
|
245
|
+
# Required. The full URI path that the request will be sent to. This string must
|
246
|
+
# begin with either "http://" or "https://". Some examples of valid values for
|
247
|
+
# uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler
|
248
|
+
# will encode some characters for safety and compatibility. The maximum allowed
|
249
|
+
# URL length is 2083 characters after encoding.
|
250
|
+
# Corresponds to the JSON property `uri`
|
251
|
+
# @return [String]
|
252
|
+
attr_accessor :uri
|
253
|
+
|
254
|
+
def initialize(**args)
|
255
|
+
update!(**args)
|
256
|
+
end
|
257
|
+
|
258
|
+
# Update properties of this object
|
259
|
+
def update!(**args)
|
260
|
+
@body = args[:body] if args.key?(:body)
|
261
|
+
@headers = args[:headers] if args.key?(:headers)
|
262
|
+
@http_method = args[:http_method] if args.key?(:http_method)
|
263
|
+
@oauth_token = args[:oauth_token] if args.key?(:oauth_token)
|
264
|
+
@oidc_token = args[:oidc_token] if args.key?(:oidc_token)
|
265
|
+
@uri = args[:uri] if args.key?(:uri)
|
266
|
+
end
|
267
|
+
end
|
268
|
+
|
269
|
+
# Configuration for a job. The maximum allowed size for a job is 100KB.
|
270
|
+
class Job
|
271
|
+
include Google::Apis::Core::Hashable
|
272
|
+
|
273
|
+
# App Engine target. The job will be pushed to a job handler by means of an HTTP
|
274
|
+
# request via an http_method such as HTTP POST, HTTP GET, etc. The job is
|
275
|
+
# acknowledged by means of an HTTP response code in the range [200 - 299]. Error
|
276
|
+
# 503 is considered an App Engine system error instead of an application error.
|
277
|
+
# Requests returning error 503 will be retried regardless of retry configuration
|
278
|
+
# and not counted against retry counts. Any other response code, or a failure to
|
279
|
+
# receive a response before the deadline, constitutes a failed attempt.
|
280
|
+
# Corresponds to the JSON property `appEngineHttpTarget`
|
281
|
+
# @return [Google::Apis::CloudschedulerV1beta1::AppEngineHttpTarget]
|
282
|
+
attr_accessor :app_engine_http_target
|
283
|
+
|
284
|
+
# The deadline for job attempts. If the request handler does not respond by this
|
285
|
+
# deadline then the request is cancelled and the attempt is marked as a `
|
286
|
+
# DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs.
|
287
|
+
# Cloud Scheduler will retry the job according to the RetryConfig. The allowed
|
288
|
+
# duration for this deadline is: * For HTTP targets, between 15 seconds and 30
|
289
|
+
# minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * For
|
290
|
+
# PubSub targets, this field is ignored.
|
291
|
+
# Corresponds to the JSON property `attemptDeadline`
|
292
|
+
# @return [String]
|
293
|
+
attr_accessor :attempt_deadline
|
294
|
+
|
295
|
+
# Optionally caller-specified in CreateJob or UpdateJob. A human-readable
|
296
|
+
# description for the job. This string must not contain more than 500 characters.
|
297
|
+
# Corresponds to the JSON property `description`
|
298
|
+
# @return [String]
|
299
|
+
attr_accessor :description
|
300
|
+
|
301
|
+
# Http target. The job will be pushed to the job handler by means of an HTTP
|
302
|
+
# request via an http_method such as HTTP POST, HTTP GET, etc. The job is
|
303
|
+
# acknowledged by means of an HTTP response code in the range [200 - 299]. A
|
304
|
+
# failure to receive a response constitutes a failed execution. For a redirected
|
305
|
+
# request, the response returned by the redirected request is considered.
|
306
|
+
# Corresponds to the JSON property `httpTarget`
|
307
|
+
# @return [Google::Apis::CloudschedulerV1beta1::HttpTarget]
|
308
|
+
attr_accessor :http_target
|
309
|
+
|
310
|
+
# Output only. The time the last job attempt started.
|
311
|
+
# Corresponds to the JSON property `lastAttemptTime`
|
312
|
+
# @return [String]
|
313
|
+
attr_accessor :last_attempt_time
|
314
|
+
|
315
|
+
# Immutable. This field is used to manage the legacy App Engine Cron jobs using
|
316
|
+
# the Cloud Scheduler API. If the field is set to true, the job will be
|
317
|
+
# considered a legacy job. Note that App Engine Cron jobs have fewer features
|
318
|
+
# than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
|
319
|
+
# Corresponds to the JSON property `legacyAppEngineCron`
|
320
|
+
# @return [Boolean]
|
321
|
+
attr_accessor :legacy_app_engine_cron
|
322
|
+
alias_method :legacy_app_engine_cron?, :legacy_app_engine_cron
|
323
|
+
|
324
|
+
# Optionally caller-specified in CreateJob, after which it becomes output only.
|
325
|
+
# The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
|
326
|
+
# JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
|
327
|
+
# hyphens (-), colons (:), or periods (.). For more information, see [
|
328
|
+
# Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
|
329
|
+
# managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
|
330
|
+
# for the job's location. The list of available locations can be obtained by
|
331
|
+
# calling ListLocations. For more information, see https://cloud.google.com/
|
332
|
+
# about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
|
333
|
+
# 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
|
334
|
+
# Corresponds to the JSON property `name`
|
335
|
+
# @return [String]
|
336
|
+
attr_accessor :name
|
337
|
+
|
338
|
+
# Pub/Sub target. The job will be delivered by publishing a message to the given
|
339
|
+
# Pub/Sub topic.
|
340
|
+
# Corresponds to the JSON property `pubsubTarget`
|
341
|
+
# @return [Google::Apis::CloudschedulerV1beta1::PubsubTarget]
|
342
|
+
attr_accessor :pubsub_target
|
343
|
+
|
344
|
+
# Settings that determine the retry behavior. By default, if a job does not
|
345
|
+
# complete successfully (meaning that an acknowledgement is not received from
|
346
|
+
# the handler, then it will be retried with exponential backoff according to the
|
347
|
+
# settings in RetryConfig.
|
348
|
+
# Corresponds to the JSON property `retryConfig`
|
349
|
+
# @return [Google::Apis::CloudschedulerV1beta1::RetryConfig]
|
350
|
+
attr_accessor :retry_config
|
351
|
+
|
352
|
+
# Required, except when used with UpdateJob. Describes the schedule on which the
|
353
|
+
# job will be executed. The schedule can be either of the following types: * [
|
354
|
+
# Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](
|
355
|
+
# https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a
|
356
|
+
# general rule, execution `n + 1` of a job will not begin until execution `n`
|
357
|
+
# has finished. Cloud Scheduler will never allow two simultaneously outstanding
|
358
|
+
# executions. For example, this implies that if the `n+1`th execution is
|
359
|
+
# scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`
|
360
|
+
# th execution will not start until `16:15`. A scheduled start time will be
|
361
|
+
# delayed if the previous execution has not ended when its scheduled time occurs.
|
362
|
+
# If retry_count > 0 and a job attempt fails, the job will be tried a total of
|
363
|
+
# retry_count times, with exponential backoff, until the next scheduled start
|
364
|
+
# time.
|
365
|
+
# Corresponds to the JSON property `schedule`
|
366
|
+
# @return [String]
|
367
|
+
attr_accessor :schedule
|
368
|
+
|
369
|
+
# Output only. The next time the job is scheduled. Note that this may be a retry
|
370
|
+
# of a previously failed attempt or the next execution time according to the
|
371
|
+
# schedule.
|
372
|
+
# Corresponds to the JSON property `scheduleTime`
|
373
|
+
# @return [String]
|
374
|
+
attr_accessor :schedule_time
|
375
|
+
|
376
|
+
# Output only. State of the job.
|
377
|
+
# Corresponds to the JSON property `state`
|
378
|
+
# @return [String]
|
379
|
+
attr_accessor :state
|
380
|
+
|
381
|
+
# The `Status` type defines a logical error model that is suitable for different
|
382
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
383
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
384
|
+
# data: error code, error message, and error details. You can find out more
|
385
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
386
|
+
# //cloud.google.com/apis/design/errors).
|
387
|
+
# Corresponds to the JSON property `status`
|
388
|
+
# @return [Google::Apis::CloudschedulerV1beta1::Status]
|
389
|
+
attr_accessor :status
|
390
|
+
|
391
|
+
# Specifies the time zone to be used in interpreting schedule. The value of this
|
392
|
+
# field must be a time zone name from the [tz database](http://en.wikipedia.org/
|
393
|
+
# wiki/Tz_database). Note that some time zones include a provision for daylight
|
394
|
+
# savings time. The rules for daylight saving time are determined by the chosen
|
395
|
+
# tz. For UTC use the string "utc". If a time zone is not specified, the default
|
396
|
+
# will be in UTC (also known as GMT).
|
397
|
+
# Corresponds to the JSON property `timeZone`
|
398
|
+
# @return [String]
|
399
|
+
attr_accessor :time_zone
|
400
|
+
|
401
|
+
# Output only. The creation time of the job.
|
402
|
+
# Corresponds to the JSON property `userUpdateTime`
|
403
|
+
# @return [String]
|
404
|
+
attr_accessor :user_update_time
|
405
|
+
|
406
|
+
def initialize(**args)
|
407
|
+
update!(**args)
|
408
|
+
end
|
409
|
+
|
410
|
+
# Update properties of this object
|
411
|
+
def update!(**args)
|
412
|
+
@app_engine_http_target = args[:app_engine_http_target] if args.key?(:app_engine_http_target)
|
413
|
+
@attempt_deadline = args[:attempt_deadline] if args.key?(:attempt_deadline)
|
414
|
+
@description = args[:description] if args.key?(:description)
|
415
|
+
@http_target = args[:http_target] if args.key?(:http_target)
|
416
|
+
@last_attempt_time = args[:last_attempt_time] if args.key?(:last_attempt_time)
|
417
|
+
@legacy_app_engine_cron = args[:legacy_app_engine_cron] if args.key?(:legacy_app_engine_cron)
|
418
|
+
@name = args[:name] if args.key?(:name)
|
419
|
+
@pubsub_target = args[:pubsub_target] if args.key?(:pubsub_target)
|
420
|
+
@retry_config = args[:retry_config] if args.key?(:retry_config)
|
421
|
+
@schedule = args[:schedule] if args.key?(:schedule)
|
422
|
+
@schedule_time = args[:schedule_time] if args.key?(:schedule_time)
|
423
|
+
@state = args[:state] if args.key?(:state)
|
424
|
+
@status = args[:status] if args.key?(:status)
|
425
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
426
|
+
@user_update_time = args[:user_update_time] if args.key?(:user_update_time)
|
427
|
+
end
|
428
|
+
end
|
429
|
+
|
430
|
+
# Response message for listing jobs using ListJobs.
|
431
|
+
class ListJobsResponse
|
432
|
+
include Google::Apis::Core::Hashable
|
433
|
+
|
434
|
+
# The list of jobs.
|
435
|
+
# Corresponds to the JSON property `jobs`
|
436
|
+
# @return [Array<Google::Apis::CloudschedulerV1beta1::Job>]
|
437
|
+
attr_accessor :jobs
|
438
|
+
|
439
|
+
# A token to retrieve next page of results. Pass this value in the page_token
|
440
|
+
# field in the subsequent call to ListJobs to retrieve the next page of results.
|
441
|
+
# If this is empty it indicates that there are no more results through which to
|
442
|
+
# paginate. The page token is valid for only 2 hours.
|
443
|
+
# Corresponds to the JSON property `nextPageToken`
|
444
|
+
# @return [String]
|
445
|
+
attr_accessor :next_page_token
|
446
|
+
|
447
|
+
def initialize(**args)
|
448
|
+
update!(**args)
|
449
|
+
end
|
450
|
+
|
451
|
+
# Update properties of this object
|
452
|
+
def update!(**args)
|
453
|
+
@jobs = args[:jobs] if args.key?(:jobs)
|
454
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
455
|
+
end
|
456
|
+
end
|
457
|
+
|
458
|
+
# The response message for Locations.ListLocations.
|
459
|
+
class ListLocationsResponse
|
460
|
+
include Google::Apis::Core::Hashable
|
461
|
+
|
462
|
+
# A list of locations that matches the specified filter in the request.
|
463
|
+
# Corresponds to the JSON property `locations`
|
464
|
+
# @return [Array<Google::Apis::CloudschedulerV1beta1::Location>]
|
465
|
+
attr_accessor :locations
|
466
|
+
|
467
|
+
# The standard List next-page token.
|
468
|
+
# Corresponds to the JSON property `nextPageToken`
|
469
|
+
# @return [String]
|
470
|
+
attr_accessor :next_page_token
|
471
|
+
|
472
|
+
def initialize(**args)
|
473
|
+
update!(**args)
|
474
|
+
end
|
475
|
+
|
476
|
+
# Update properties of this object
|
477
|
+
def update!(**args)
|
478
|
+
@locations = args[:locations] if args.key?(:locations)
|
479
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
480
|
+
end
|
481
|
+
end
|
482
|
+
|
483
|
+
# A resource that represents Google Cloud Platform location.
|
484
|
+
class Location
|
485
|
+
include Google::Apis::Core::Hashable
|
486
|
+
|
487
|
+
# The friendly name for this location, typically a nearby city name. For example,
|
488
|
+
# "Tokyo".
|
489
|
+
# Corresponds to the JSON property `displayName`
|
490
|
+
# @return [String]
|
491
|
+
attr_accessor :display_name
|
492
|
+
|
493
|
+
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
|
494
|
+
# region": "us-east1"`
|
495
|
+
# Corresponds to the JSON property `labels`
|
496
|
+
# @return [Hash<String,String>]
|
497
|
+
attr_accessor :labels
|
498
|
+
|
499
|
+
# The canonical id for this location. For example: `"us-east1"`.
|
500
|
+
# Corresponds to the JSON property `locationId`
|
501
|
+
# @return [String]
|
502
|
+
attr_accessor :location_id
|
503
|
+
|
504
|
+
# Service-specific metadata. For example the available capacity at the given
|
505
|
+
# location.
|
506
|
+
# Corresponds to the JSON property `metadata`
|
507
|
+
# @return [Hash<String,Object>]
|
508
|
+
attr_accessor :metadata
|
509
|
+
|
510
|
+
# Resource name for the location, which may vary between implementations. For
|
511
|
+
# example: `"projects/example-project/locations/us-east1"`
|
512
|
+
# Corresponds to the JSON property `name`
|
513
|
+
# @return [String]
|
514
|
+
attr_accessor :name
|
515
|
+
|
516
|
+
def initialize(**args)
|
517
|
+
update!(**args)
|
518
|
+
end
|
519
|
+
|
520
|
+
# Update properties of this object
|
521
|
+
def update!(**args)
|
522
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
523
|
+
@labels = args[:labels] if args.key?(:labels)
|
524
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
525
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
526
|
+
@name = args[:name] if args.key?(:name)
|
527
|
+
end
|
528
|
+
end
|
529
|
+
|
530
|
+
# Contains information needed for generating an [OAuth token](https://developers.
|
531
|
+
# google.com/identity/protocols/OAuth2). This type of authorization should
|
532
|
+
# generally only be used when calling Google APIs hosted on *.googleapis.com.
|
533
|
+
class OAuthToken
|
534
|
+
include Google::Apis::Core::Hashable
|
535
|
+
|
536
|
+
# OAuth scope to be used for generating OAuth access token. If not specified, "
|
537
|
+
# https://www.googleapis.com/auth/cloud-platform" will be used.
|
538
|
+
# Corresponds to the JSON property `scope`
|
539
|
+
# @return [String]
|
540
|
+
attr_accessor :scope
|
541
|
+
|
542
|
+
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
|
543
|
+
# be used for generating OAuth token. The service account must be within the
|
544
|
+
# same project as the job. The caller must have iam.serviceAccounts.actAs
|
545
|
+
# permission for the service account.
|
546
|
+
# Corresponds to the JSON property `serviceAccountEmail`
|
547
|
+
# @return [String]
|
548
|
+
attr_accessor :service_account_email
|
549
|
+
|
550
|
+
def initialize(**args)
|
551
|
+
update!(**args)
|
552
|
+
end
|
553
|
+
|
554
|
+
# Update properties of this object
|
555
|
+
def update!(**args)
|
556
|
+
@scope = args[:scope] if args.key?(:scope)
|
557
|
+
@service_account_email = args[:service_account_email] if args.key?(:service_account_email)
|
558
|
+
end
|
559
|
+
end
|
560
|
+
|
561
|
+
# Contains information needed for generating an [OpenID Connect token](https://
|
562
|
+
# developers.google.com/identity/protocols/OpenIDConnect). This type of
|
563
|
+
# authorization can be used for many scenarios, including calling Cloud Run, or
|
564
|
+
# endpoints where you intend to validate the token yourself.
|
565
|
+
class OidcToken
|
566
|
+
include Google::Apis::Core::Hashable
|
567
|
+
|
568
|
+
# Audience to be used when generating OIDC token. If not specified, the URI
|
569
|
+
# specified in target will be used.
|
570
|
+
# Corresponds to the JSON property `audience`
|
571
|
+
# @return [String]
|
572
|
+
attr_accessor :audience
|
573
|
+
|
574
|
+
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
|
575
|
+
# be used for generating OIDC token. The service account must be within the same
|
576
|
+
# project as the job. The caller must have iam.serviceAccounts.actAs permission
|
577
|
+
# for the service account.
|
578
|
+
# Corresponds to the JSON property `serviceAccountEmail`
|
579
|
+
# @return [String]
|
580
|
+
attr_accessor :service_account_email
|
581
|
+
|
582
|
+
def initialize(**args)
|
583
|
+
update!(**args)
|
584
|
+
end
|
585
|
+
|
586
|
+
# Update properties of this object
|
587
|
+
def update!(**args)
|
588
|
+
@audience = args[:audience] if args.key?(:audience)
|
589
|
+
@service_account_email = args[:service_account_email] if args.key?(:service_account_email)
|
590
|
+
end
|
591
|
+
end
|
592
|
+
|
593
|
+
# Request message for PauseJob.
|
594
|
+
class PauseJobRequest
|
595
|
+
include Google::Apis::Core::Hashable
|
596
|
+
|
597
|
+
def initialize(**args)
|
598
|
+
update!(**args)
|
599
|
+
end
|
600
|
+
|
601
|
+
# Update properties of this object
|
602
|
+
def update!(**args)
|
603
|
+
end
|
604
|
+
end
|
605
|
+
|
606
|
+
# A message that is published by publishers and consumed by subscribers. The
|
607
|
+
# message must contain either a non-empty data field or at least one attribute.
|
608
|
+
# Note that client libraries represent this object differently depending on the
|
609
|
+
# language. See the corresponding [client library documentation](https://cloud.
|
610
|
+
# google.com/pubsub/docs/reference/libraries) for more information. See [quotas
|
611
|
+
# and limits] (https://cloud.google.com/pubsub/quotas) for more information
|
612
|
+
# about message limits.
|
613
|
+
class PubsubMessage
|
614
|
+
include Google::Apis::Core::Hashable
|
615
|
+
|
616
|
+
# Attributes for this message. If this field is empty, the message must contain
|
617
|
+
# non-empty data. This can be used to filter messages on the subscription.
|
618
|
+
# Corresponds to the JSON property `attributes`
|
619
|
+
# @return [Hash<String,String>]
|
620
|
+
attr_accessor :attributes
|
621
|
+
|
622
|
+
# The message data field. If this field is empty, the message must contain at
|
623
|
+
# least one attribute.
|
624
|
+
# Corresponds to the JSON property `data`
|
625
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
626
|
+
# @return [String]
|
627
|
+
attr_accessor :data
|
628
|
+
|
629
|
+
# ID of this message, assigned by the server when the message is published.
|
630
|
+
# Guaranteed to be unique within the topic. This value may be read by a
|
631
|
+
# subscriber that receives a `PubsubMessage` via a `Pull` call or a push
|
632
|
+
# delivery. It must not be populated by the publisher in a `Publish` call.
|
633
|
+
# Corresponds to the JSON property `messageId`
|
634
|
+
# @return [String]
|
635
|
+
attr_accessor :message_id
|
636
|
+
|
637
|
+
# If non-empty, identifies related messages for which publish order should be
|
638
|
+
# respected. If a `Subscription` has `enable_message_ordering` set to `true`,
|
639
|
+
# messages published with the same non-empty `ordering_key` value will be
|
640
|
+
# delivered to subscribers in the order in which they are received by the Pub/
|
641
|
+
# Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
|
642
|
+
# specify the same `ordering_key` value.
|
643
|
+
# Corresponds to the JSON property `orderingKey`
|
644
|
+
# @return [String]
|
645
|
+
attr_accessor :ordering_key
|
646
|
+
|
647
|
+
# The time at which the message was published, populated by the server when it
|
648
|
+
# receives the `Publish` call. It must not be populated by the publisher in a `
|
649
|
+
# Publish` call.
|
650
|
+
# Corresponds to the JSON property `publishTime`
|
651
|
+
# @return [String]
|
652
|
+
attr_accessor :publish_time
|
653
|
+
|
654
|
+
def initialize(**args)
|
655
|
+
update!(**args)
|
656
|
+
end
|
657
|
+
|
658
|
+
# Update properties of this object
|
659
|
+
def update!(**args)
|
660
|
+
@attributes = args[:attributes] if args.key?(:attributes)
|
661
|
+
@data = args[:data] if args.key?(:data)
|
662
|
+
@message_id = args[:message_id] if args.key?(:message_id)
|
663
|
+
@ordering_key = args[:ordering_key] if args.key?(:ordering_key)
|
664
|
+
@publish_time = args[:publish_time] if args.key?(:publish_time)
|
665
|
+
end
|
666
|
+
end
|
667
|
+
|
668
|
+
# Pub/Sub target. The job will be delivered by publishing a message to the given
|
669
|
+
# Pub/Sub topic.
|
670
|
+
class PubsubTarget
|
671
|
+
include Google::Apis::Core::Hashable
|
672
|
+
|
673
|
+
# Attributes for PubsubMessage. Pubsub message must contain either non-empty
|
674
|
+
# data, or at least one attribute.
|
675
|
+
# Corresponds to the JSON property `attributes`
|
676
|
+
# @return [Hash<String,String>]
|
677
|
+
attr_accessor :attributes
|
678
|
+
|
679
|
+
# The message payload for PubsubMessage. Pubsub message must contain either non-
|
680
|
+
# empty data, or at least one attribute.
|
681
|
+
# Corresponds to the JSON property `data`
|
682
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
683
|
+
# @return [String]
|
684
|
+
attr_accessor :data
|
685
|
+
|
686
|
+
# Required. The name of the Cloud Pub/Sub topic to which messages will be
|
687
|
+
# published when a job is delivered. The topic name must be in the same format
|
688
|
+
# as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/
|
689
|
+
# docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/
|
690
|
+
# PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the
|
691
|
+
# Cloud Scheduler job.
|
692
|
+
# Corresponds to the JSON property `topicName`
|
693
|
+
# @return [String]
|
694
|
+
attr_accessor :topic_name
|
695
|
+
|
696
|
+
def initialize(**args)
|
697
|
+
update!(**args)
|
698
|
+
end
|
699
|
+
|
700
|
+
# Update properties of this object
|
701
|
+
def update!(**args)
|
702
|
+
@attributes = args[:attributes] if args.key?(:attributes)
|
703
|
+
@data = args[:data] if args.key?(:data)
|
704
|
+
@topic_name = args[:topic_name] if args.key?(:topic_name)
|
705
|
+
end
|
706
|
+
end
|
707
|
+
|
708
|
+
# Request message for ResumeJob.
|
709
|
+
class ResumeJobRequest
|
710
|
+
include Google::Apis::Core::Hashable
|
711
|
+
|
712
|
+
def initialize(**args)
|
713
|
+
update!(**args)
|
714
|
+
end
|
715
|
+
|
716
|
+
# Update properties of this object
|
717
|
+
def update!(**args)
|
718
|
+
end
|
719
|
+
end
|
720
|
+
|
721
|
+
# Settings that determine the retry behavior. By default, if a job does not
|
722
|
+
# complete successfully (meaning that an acknowledgement is not received from
|
723
|
+
# the handler, then it will be retried with exponential backoff according to the
|
724
|
+
# settings in RetryConfig.
|
725
|
+
class RetryConfig
|
726
|
+
include Google::Apis::Core::Hashable
|
727
|
+
|
728
|
+
# The maximum amount of time to wait before retrying a job after it fails. The
|
729
|
+
# default value of this field is 1 hour.
|
730
|
+
# Corresponds to the JSON property `maxBackoffDuration`
|
731
|
+
# @return [String]
|
732
|
+
attr_accessor :max_backoff_duration
|
733
|
+
|
734
|
+
# The time between retries will double `max_doublings` times. A job's retry
|
735
|
+
# interval starts at min_backoff_duration, then doubles `max_doublings` times,
|
736
|
+
# then increases linearly, and finally retries at intervals of
|
737
|
+
# max_backoff_duration up to retry_count times. For example, if
|
738
|
+
# min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings`
|
739
|
+
# is 3, then the a job will first be retried in 10s. The retry interval will
|
740
|
+
# double three times, and then increase linearly by 2^3 * 10s. Finally, the job
|
741
|
+
# will retry at intervals of max_backoff_duration until the job has been
|
742
|
+
# attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s,
|
743
|
+
# 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
|
744
|
+
# Corresponds to the JSON property `maxDoublings`
|
745
|
+
# @return [Fixnum]
|
746
|
+
attr_accessor :max_doublings
|
747
|
+
|
748
|
+
# The time limit for retrying a failed job, measured from time when an execution
|
749
|
+
# was first attempted. If specified with retry_count, the job will be retried
|
750
|
+
# until both limits are reached. The default value for max_retry_duration is
|
751
|
+
# zero, which means retry duration is unlimited.
|
752
|
+
# Corresponds to the JSON property `maxRetryDuration`
|
753
|
+
# @return [String]
|
754
|
+
attr_accessor :max_retry_duration
|
755
|
+
|
756
|
+
# The minimum amount of time to wait before retrying a job after it fails. The
|
757
|
+
# default value of this field is 5 seconds.
|
758
|
+
# Corresponds to the JSON property `minBackoffDuration`
|
759
|
+
# @return [String]
|
760
|
+
attr_accessor :min_backoff_duration
|
761
|
+
|
762
|
+
# The number of attempts that the system will make to run a job using the
|
763
|
+
# exponential backoff procedure described by max_doublings. The default value of
|
764
|
+
# retry_count is zero. If retry_count is zero, a job attempt will *not* be
|
765
|
+
# retried if it fails. Instead the Cloud Scheduler system will wait for the next
|
766
|
+
# scheduled execution time. If retry_count is set to a non-zero number then
|
767
|
+
# Cloud Scheduler will retry failed attempts, using exponential backoff,
|
768
|
+
# retry_count times, or until the next scheduled execution time, whichever comes
|
769
|
+
# first. Values greater than 5 and negative values are not allowed.
|
770
|
+
# Corresponds to the JSON property `retryCount`
|
771
|
+
# @return [Fixnum]
|
772
|
+
attr_accessor :retry_count
|
773
|
+
|
774
|
+
def initialize(**args)
|
775
|
+
update!(**args)
|
776
|
+
end
|
777
|
+
|
778
|
+
# Update properties of this object
|
779
|
+
def update!(**args)
|
780
|
+
@max_backoff_duration = args[:max_backoff_duration] if args.key?(:max_backoff_duration)
|
781
|
+
@max_doublings = args[:max_doublings] if args.key?(:max_doublings)
|
782
|
+
@max_retry_duration = args[:max_retry_duration] if args.key?(:max_retry_duration)
|
783
|
+
@min_backoff_duration = args[:min_backoff_duration] if args.key?(:min_backoff_duration)
|
784
|
+
@retry_count = args[:retry_count] if args.key?(:retry_count)
|
785
|
+
end
|
786
|
+
end
|
787
|
+
|
788
|
+
# Request message for forcing a job to run now using RunJob.
|
789
|
+
class RunJobRequest
|
790
|
+
include Google::Apis::Core::Hashable
|
791
|
+
|
792
|
+
# This field is used to manage the legacy App Engine Cron jobs using the Cloud
|
793
|
+
# Scheduler API. If the field is set to true, the job in the __cron queue with
|
794
|
+
# the corresponding name will be forced to run instead.
|
795
|
+
# Corresponds to the JSON property `legacyAppEngineCron`
|
796
|
+
# @return [Boolean]
|
797
|
+
attr_accessor :legacy_app_engine_cron
|
798
|
+
alias_method :legacy_app_engine_cron?, :legacy_app_engine_cron
|
799
|
+
|
800
|
+
def initialize(**args)
|
801
|
+
update!(**args)
|
802
|
+
end
|
803
|
+
|
804
|
+
# Update properties of this object
|
805
|
+
def update!(**args)
|
806
|
+
@legacy_app_engine_cron = args[:legacy_app_engine_cron] if args.key?(:legacy_app_engine_cron)
|
807
|
+
end
|
808
|
+
end
|
809
|
+
|
810
|
+
# The `Status` type defines a logical error model that is suitable for different
|
811
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
812
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
813
|
+
# data: error code, error message, and error details. You can find out more
|
814
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
815
|
+
# //cloud.google.com/apis/design/errors).
|
816
|
+
class Status
|
817
|
+
include Google::Apis::Core::Hashable
|
818
|
+
|
819
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
820
|
+
# Corresponds to the JSON property `code`
|
821
|
+
# @return [Fixnum]
|
822
|
+
attr_accessor :code
|
823
|
+
|
824
|
+
# A list of messages that carry the error details. There is a common set of
|
825
|
+
# message types for APIs to use.
|
826
|
+
# Corresponds to the JSON property `details`
|
827
|
+
# @return [Array<Hash<String,Object>>]
|
828
|
+
attr_accessor :details
|
829
|
+
|
830
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
831
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
832
|
+
# field, or localized by the client.
|
833
|
+
# Corresponds to the JSON property `message`
|
834
|
+
# @return [String]
|
835
|
+
attr_accessor :message
|
836
|
+
|
837
|
+
def initialize(**args)
|
838
|
+
update!(**args)
|
839
|
+
end
|
840
|
+
|
841
|
+
# Update properties of this object
|
842
|
+
def update!(**args)
|
843
|
+
@code = args[:code] if args.key?(:code)
|
844
|
+
@details = args[:details] if args.key?(:details)
|
845
|
+
@message = args[:message] if args.key?(:message)
|
846
|
+
end
|
847
|
+
end
|
848
|
+
end
|
849
|
+
end
|
850
|
+
end
|