-
Notifications
You must be signed in to change notification settings - Fork 215
/
cloudscheduler_v1beta1_cloudschedulerjob.yaml
550 lines (546 loc) · 30.7 KB
/
cloudscheduler_v1beta1_cloudschedulerjob.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
cnrm.cloud.google.com/version: 1.122.0
creationTimestamp: null
labels:
cnrm.cloud.google.com/dcl2crd: "true"
cnrm.cloud.google.com/managed-by-kcc: "true"
cnrm.cloud.google.com/stability-level: stable
cnrm.cloud.google.com/system: "true"
name: cloudschedulerjobs.cloudscheduler.cnrm.cloud.google.com
spec:
group: cloudscheduler.cnrm.cloud.google.com
names:
categories:
- gcp
kind: CloudSchedulerJob
plural: cloudschedulerjobs
shortNames:
- gcpcloudschedulerjob
- gcpcloudschedulerjobs
singular: cloudschedulerjob
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- description: When 'True', the most recent reconcile of the resource succeeded
jsonPath: .status.conditions[?(@.type=='Ready')].status
name: Ready
type: string
- description: The reason for the value in 'Ready'
jsonPath: .status.conditions[?(@.type=='Ready')].reason
name: Status
type: string
- description: The last transition time for the value in 'Status'
jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
name: Status Age
type: date
name: v1beta1
schema:
openAPIV3Schema:
properties:
apiVersion:
description: 'apiVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
type: string
kind:
description: 'kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
properties:
appEngineHttpTarget:
description: App Engine HTTP target.
properties:
appEngineRouting:
description: App Engine Routing setting for the job.
properties:
instance:
description: App instance. By default, the job is sent to
an instance which is available when the job is attempted.
Requests can only be sent to a specific instance if [manual
scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
App Engine Flex does not support instances. For more information,
see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
type: string
service:
description: App service. By default, the job is sent to the
service which is the default service when the job is attempted.
type: string
version:
description: App version. By default, the job is sent to the
version which is the default version when the job is attempted.
type: string
type: object
body:
description: Body. HTTP request body. A request body is allowed
only if the HTTP method is POST or PUT. It will result in invalid
argument error to set a body on a job with an incompatible HttpMethod.
type: string
headers:
additionalProperties:
type: string
description: 'HTTP request headers. This map contains the header
field names and values. Headers can be set when the job is created.
Cloud Scheduler sets some headers to default values: * `User-Agent`:
By default, this header is `"App Engine-Google; (+http://code.google.com/appengine)"`.
This header can be modified, but Cloud Scheduler will append
`"App Engine-Google; (+http://code.google.com/appengine)"` to
the modified `User-Agent`. * `X-CloudScheduler`: This header
will be set to true. The headers below are output only. They
cannot be set or overridden: * `X-Google-*`: For Google internal
use only. * `X-App Engine-*`: For Google internal use only.
In addition, some App Engine headers, which contain job-specific
information, are also be sent to the job handler.'
type: object
httpMethod:
description: 'The HTTP method to use for the request. PATCH and
OPTIONS are not permitted. Possible values: HTTP_METHOD_UNSPECIFIED,
POST, GET, HEAD, PUT, DELETE, PATCH, OPTIONS'
type: string
relativeUri:
description: The relative URI. The relative URL must begin with
"/" and must be a valid HTTP relative URL. It can contain a
path, query string arguments, and `#` fragments. If the relative
URL is empty, then the root path "/" will be used. No spaces
are allowed, and the maximum length allowed is 2083 characters.
type: string
type: object
attemptDeadline:
description: 'The deadline for job attempts. If the request handler
does not respond by this deadline then the request is cancelled
and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The
failed attempt can be viewed in execution logs. Cloud Scheduler
will retry the job according to the RetryConfig. The allowed duration
for this deadline is: * For HTTP targets, between 15 seconds and
30 minutes. * For App Engine HTTP targets, between 15 seconds and
24 hours.'
type: string
description:
description: Optionally caller-specified in CreateJob or UpdateJob.
A human-readable description for the job. This string must not contain
more than 500 characters.
type: string
httpTarget:
description: HTTP target.
properties:
body:
description: HTTP request body. A request body is allowed only
if the HTTP method is POST, PUT, or PATCH. It is an error to
set body on a job with an incompatible HttpMethod.
type: string
headers:
additionalProperties:
type: string
description: 'The user can specify HTTP request headers to send
with the job''s HTTP request. This map contains the header field
names and values. Repeated headers are not supported, but a
header value can contain commas. These headers represent a subset
of the headers that will accompany the job''s HTTP request.
Some HTTP request headers will be ignored or replaced. A partial
list of headers that will be ignored or replaced is below: -
Host: This will be computed by Cloud Scheduler and derived from
uri. * `Content-Length`: This will be computed by Cloud Scheduler.
* `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
* `X-Google-*`: Google internal use only. * `X-appengine-*`:
Google internal use only. The total size of headers must be
less than 80KB.'
type: object
httpMethod:
description: 'Which HTTP method to use for the request. Possible
values: HTTP_METHOD_UNSPECIFIED, POST, GET, HEAD, PUT, DELETE,
PATCH, OPTIONS'
type: string
oauthToken:
description: If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
will be generated and attached as an `Authorization` header
in the HTTP request. This type of authorization should generally
only be used when calling Google APIs hosted on *.googleapis.com.
properties:
scope:
description: OAuth scope to be used for generating OAuth access
token. If not specified, "https://www.googleapis.com/auth/cloud-platform"
will be used.
type: string
serviceAccountRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: |-
[Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
Allowed value: The `email` field of an `IAMServiceAccount` resource.
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
type: object
oidcToken:
description: If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header
in the HTTP request. This type of authorization can be used
for many scenarios, including calling Cloud Run, or endpoints
where you intend to validate the token yourself.
properties:
audience:
description: Audience to be used when generating OIDC token.
If not specified, the URI specified in target will be used.
type: string
serviceAccountRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: |-
[Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
Allowed value: The `email` field of an `IAMServiceAccount` resource.
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
type: object
uri:
description: 'Required. The full URI path that the request will
be sent to. This string must begin with either "http://" or
"https://". Some examples of valid values for uri are: `http://acme.com`
and `https://acme.com/sales:8080`. Cloud Scheduler will encode
some characters for safety and compatibility. The maximum allowed
URL length is 2083 characters after encoding.'
type: string
required:
- uri
type: object
location:
description: Immutable. The location for the resource
type: string
pubsubTarget:
description: Pub/Sub target.
properties:
attributes:
additionalProperties:
type: string
description: Attributes for PubsubMessage. Pubsub message must
contain either non-empty data, or at least one attribute.
type: object
data:
description: The message payload for PubsubMessage. Pubsub message
must contain either non-empty data, or at least one attribute.
type: string
topicRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: |-
Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
Allowed value: The Google Cloud resource name of a `PubSubTopic` resource (format: `projects/{{project}}/topics/{{name}}`).
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
required:
- topicRef
type: object
resourceID:
description: Immutable. Optional. The name of the resource. Used for
creation and acquisition. When unset, the value of `metadata.name`
is used as the default.
type: string
retryConfig:
description: Settings that determine the retry behavior.
properties:
maxBackoffDuration:
description: The maximum amount of time to wait before retrying
a job after it fails. The default value of this field is 1 hour.
type: string
maxDoublings:
description: The time between retries will double `max_doublings`
times. A job's retry interval starts at min_backoff_duration,
then doubles `max_doublings` times, then increases linearly,
and finally retries at intervals of max_backoff_duration up
to retry_count times. For example, if min_backoff_duration is
10s, max_backoff_duration is 300s, and `max_doublings` is 3,
then the a job will first be retried in 10s. The retry interval
will double three times, and then increase linearly by 2^3 *
10s. Finally, the job will retry at intervals of max_backoff_duration
until the job has been attempted retry_count times. Thus, the
requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
300s, .... The default value of this field is 5.
format: int64
type: integer
maxRetryDuration:
description: The time limit for retrying a failed job, measured
from time when an execution was first attempted. If specified
with retry_count, the job will be retried until both limits
are reached. The default value for max_retry_duration is zero,
which means retry duration is unlimited.
type: string
minBackoffDuration:
description: The minimum amount of time to wait before retrying
a job after it fails. The default value of this field is 5 seconds.
type: string
retryCount:
description: The number of attempts that the system will make
to run a job using the exponential backoff procedure described
by max_doublings. The default value of retry_count is zero.
If retry_count is zero, a job attempt will *not* be retried
if it fails. Instead the Cloud Scheduler system will wait for
the next scheduled execution time. If retry_count is set to
a non-zero number then Cloud Scheduler will retry failed attempts,
using exponential backoff, retry_count times, or until the next
scheduled execution time, whichever comes first. Values greater
than 5 and negative values are not allowed.
format: int64
type: integer
type: object
schedule:
description: 'Required, except when used with UpdateJob. Describes
the schedule on which the job will be executed. The schedule can
be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)
* English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)
As a general rule, execution `n + 1` of a job will not begin until
execution `n` has finished. Cloud Scheduler will never allow two
simultaneously outstanding executions. For example, this implies
that if the `n+1`th execution is scheduled to run at 16:00 but the
`n`th execution takes until 16:15, the `n+1`th execution will not
start until `16:15`. A scheduled start time will be delayed if the
previous execution has not ended when its scheduled time occurs.
If retry_count > 0 and a job attempt fails, the job will be tried
a total of retry_count times, with exponential backoff, until the
next scheduled start time.'
type: string
timeZone:
description: Specifies the time zone to be used in interpreting schedule.
The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).
Note that some time zones include a provision for daylight savings
time. The rules for daylight saving time are determined by the chosen
tz. For UTC use the string "utc". If a time zone is not specified,
the default will be in UTC (also known as GMT).
type: string
required:
- location
type: object
status:
properties:
appEngineHttpTarget:
properties:
appEngineRouting:
properties:
host:
description: 'Output only. The host that the job is sent to.
For more information about how App Engine requests are routed,
see [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
The host is constructed as: * `host = [application_domain_name]`
`| [service] + ''.'' + [application_domain_name]` `| [version]
+ ''.'' + [application_domain_name]` `| [version_dot_service]+
''.'' + [application_domain_name]` `| [instance] + ''.''
+ [application_domain_name]` `| [instance_dot_service] +
''.'' + [application_domain_name]` `| [instance_dot_version]
+ ''.'' + [application_domain_name]` `| [instance_dot_version_dot_service]
+ ''.'' + [application_domain_name]` * `application_domain_name`
= The domain name of the app, for example .appspot.com,
which is associated with the job''s project ID. * `service
=` service * `version =` version * `version_dot_service
=` version `+ ''.'' +` service * `instance =` instance *
`instance_dot_service =` instance `+ ''.'' +` service *
`instance_dot_version =` instance `+ ''.'' +` version *
`instance_dot_version_dot_service =` instance `+ ''.'' +`
version `+ ''.'' +` service If service is empty, then the
job will be sent to the service which is the default service
when the job is attempted. If version is empty, then the
job will be sent to the version which is the default version
when the job is attempted. If instance is empty, then the
job will be sent to an instance which is available when
the job is attempted. If service, version, or instance is
invalid, then the job will be sent to the default version
of the default service when the job is attempted.'
type: string
type: object
type: object
conditions:
description: Conditions represent the latest available observation
of the resource's current state.
items:
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
type: string
message:
description: Human-readable message indicating details about
last transition.
type: string
reason:
description: Unique, one-word, CamelCase reason for the condition's
last transition.
type: string
status:
description: Status is the status of the condition. Can be True,
False, Unknown.
type: string
type:
description: Type is the type of the condition.
type: string
type: object
type: array
lastAttemptTime:
description: Output only. The time the last job attempt started.
format: date-time
type: string
observedGeneration:
description: ObservedGeneration is the generation of the resource
that was most recently observed by the Config Connector controller.
If this is equal to metadata.generation, then that means that the
current reported status reflects the most recent desired state of
the resource.
type: integer
scheduleTime:
description: Output only. The next time the job is scheduled. Note
that this may be a retry of a previously failed attempt or the next
execution time according to the schedule.
format: date-time
type: string
state:
description: 'Output only. State of the job. Possible values: STATE_UNSPECIFIED,
ENABLED, PAUSED, DISABLED, UPDATE_FAILED'
type: string
status:
description: Output only. The response from the target for the last
attempted execution.
properties:
code:
description: The status code, which should be an enum value of
google.rpc.Code.
format: int64
type: integer
details:
description: A list of messages that carry the error details.
There is a common set of message types for APIs to use.
items:
properties:
typeUrl:
description: 'A URL/resource name that uniquely identifies
the type of the serialized protocol buffer message. This
string must contain at least one "/" character. The last
segment of the URL''s path must represent the fully qualified
name of the type (as in `path/google.protobuf.Duration`).
The name should be in a canonical form (e.g., leading
"." is not accepted). In practice, teams usually precompile
into the binary all types that they expect it to use in
the context of Any. However, for URLs which use the scheme
`http`, `https`, or no scheme, one can optionally set
up a type server that maps type URLs to message definitions
as follows: * If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a google.protobuf.Type
value in binary format, or produce an error. * Applications
are allowed to cache lookup results based on the URL,
or have them precompiled into a binary to avoid any lookup.
Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.) Note: this functionality is not currently
available in the official protobuf release, and it is
not used for type URLs beginning with type.googleapis.com.
Schemes other than `http`, `https` (or the empty scheme)
might be used with implementation specific semantics.'
type: string
value:
description: Must be a valid serialized protocol buffer
of the above specified type.
type: string
type: object
type: array
message:
description: A developer-facing error message, which should be
in English. Any user-facing error message should be localized
and sent in the google.rpc.Status.details field, or localized
by the client.
type: string
type: object
userUpdateTime:
description: Output only. The creation time of the job.
format: date-time
type: string
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []