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
# Cloud Scheduler API — Full Reference Manifest
# Auto-generated by reference.py — DO NOT HAND-EDIT
# This file contains EVERY schema and operation from the discovery doc.
# Use it as a reference when extending codegen/manifests/cloudscheduler.toml
#
# Schemas: 22 total, 13 in manifest
# Operations: 16 total, 8 in manifest
#
# Legend:
# [IN MANIFEST] = already in the curated manifest
# format: byte = needs format = "bytes" override
# RESERVED_WORD = needs rust_name + serde_rename override
# ======================================================================
# SCHEMAS (22 total)
# ======================================================================
# --- AppEngineHttpTarget (5 fields) [IN MANIFEST] ---
# App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_m
# WARNING: format:"byte" fields: body
# [[types]]
# schema = "AppEngineHttpTarget"
# include_fields = ["appEngineRouting", "body", "headers", "httpMethod", "relativeUri"]
#
# appEngineRouting: $ref: AppEngineRouting
# body: string, format: byte
# headers: map<string, string>
# httpMethod: string, enum: [HTTP_METHOD_UNSPECIFIED, POST, GET, HEAD, ... +4]
# relativeUri: string
#
# [types.field_overrides]
# body = { format = "bytes" }
# # httpMethod = { enum_type = "AppEngineHttpTargetHttpMethod" }
# --- AppEngineRouting (4 fields) [IN MANIFEST] ---
# App Engine Routing. For more information about services, versions, and instances see [An Overview of
# [[types]]
# schema = "AppEngineRouting"
# include_fields = ["host", "instance", "service", "version"]
#
# host: string
# instance: string
# service: string
# version: string
# --- CancelOperationRequest (0 fields) ---
# The request message for Operations.CancelOperation.
# [[types]]
# schema = "CancelOperationRequest"
# --- CmekConfig (2 fields) ---
# Describes the project/location configuration of Cloud Scheduler Resources.
# [[types]]
# schema = "CmekConfig"
# include_fields = ["kmsKeyName", "name"]
#
# kmsKeyName: string
# name: string
#
# [types.field_overrides]
# name = { required = true }
# --- Empty (0 fields) [IN MANIFEST] ---
# A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs
# [[types]]
# schema = "Empty"
# --- HttpTarget (6 fields) [IN MANIFEST] ---
# Http target. The job will be pushed to the job handler by means of an HTTP request via an http_metho
# WARNING: format:"byte" fields: body
# [[types]]
# schema = "HttpTarget"
# include_fields = ["body", "headers", "httpMethod", "oauthToken", "oidcToken", "uri"]
#
# body: string, format: byte
# headers: map<string, string>
# httpMethod: string, enum: [HTTP_METHOD_UNSPECIFIED, POST, GET, HEAD, ... +4]
# oauthToken: $ref: OAuthToken
# oidcToken: $ref: OidcToken
# uri: string
#
# [types.field_overrides]
# body = { format = "bytes" }
# # httpMethod = { enum_type = "HttpTargetHttpMethod" }
# --- Job (15 fields) [IN MANIFEST] ---
# Configuration for a job. The maximum allowed size for a job is 1MB.
# [[types]]
# schema = "Job"
# include_fields = ["appEngineHttpTarget", "attemptDeadline", "description", "httpTarget", "lastAttemptTime", "name", "pubsubTarget", "retryConfig", "satisfiesPzs", "schedule", "scheduleTime", "state", "status", "timeZone", "userUpdateTime"]
#
# appEngineHttpTarget: $ref: AppEngineHttpTarget
# attemptDeadline: string, format: google-duration
# description: string
# httpTarget: $ref: HttpTarget
# lastAttemptTime: string, format: google-datetime, readOnly
# name: string
# pubsubTarget: $ref: PubsubTarget
# retryConfig: $ref: RetryConfig
# satisfiesPzs: boolean, readOnly
# schedule: string
# scheduleTime: string, format: google-datetime, readOnly
# state: string, enum: [STATE_UNSPECIFIED, ENABLED, PAUSED, DISABLED, UPDATE_FAILED], readOnly
# status: $ref: Status, readOnly
# timeZone: string
# userUpdateTime: string, format: google-datetime, readOnly
#
# [types.field_overrides]
# name = { required = true }
# # state = { enum_type = "JobState" }
# --- ListJobsResponse (2 fields) ---
# Response message for listing jobs using ListJobs.
# [[types]]
# schema = "ListJobsResponse"
# include_fields = ["jobs", "nextPageToken"]
#
# jobs: array<Job>
# nextPageToken: string
# --- ListLocationsResponse (2 fields) ---
# The response message for Locations.ListLocations.
# [[types]]
# schema = "ListLocationsResponse"
# include_fields = ["locations", "nextPageToken"]
#
# locations: array<Location>
# nextPageToken: string
# --- ListOperationsResponse (3 fields) ---
# The response message for Operations.ListOperations.
# [[types]]
# schema = "ListOperationsResponse"
# include_fields = ["nextPageToken", "operations", "unreachable"]
#
# nextPageToken: string
# operations: array<Operation>
# unreachable: array<string>
# --- Location (5 fields) ---
# A resource that represents a Google Cloud location.
# [[types]]
# schema = "Location"
# include_fields = ["displayName", "labels", "locationId", "metadata", "name"]
#
# displayName: string
# labels: map<string, string>
# locationId: string
# metadata: map<string, any>
# name: string
#
# [types.field_overrides]
# name = { required = true }
# --- OAuthToken (2 fields) [IN MANIFEST] ---
# Contains information needed for generating an [OAuth token](https://developers.google.com/identity/p
# [[types]]
# schema = "OAuthToken"
# include_fields = ["scope", "serviceAccountEmail"]
#
# scope: string
# serviceAccountEmail: string
# --- OidcToken (2 fields) [IN MANIFEST] ---
# Contains information needed for generating an [OpenID Connect token](https://developers.google.com/i
# [[types]]
# schema = "OidcToken"
# include_fields = ["audience", "serviceAccountEmail"]
#
# audience: string
# serviceAccountEmail: string
# --- Operation (5 fields) ---
# This resource represents a long-running operation that is the result of a network API call.
# [[types]]
# schema = "Operation"
# include_fields = ["done", "error", "metadata", "name", "response"]
#
# done: boolean
# error: $ref: Status
# metadata: map<string, any>
# name: string
# response: map<string, any>
#
# [types.field_overrides]
# name = { required = true }
# --- OperationMetadata (7 fields) ---
# Represents the metadata of the long-running operation.
# [[types]]
# schema = "OperationMetadata"
# include_fields = ["apiVersion", "cancelRequested", "createTime", "endTime", "statusDetail", "target", "verb"]
#
# apiVersion: string, readOnly
# cancelRequested: boolean, readOnly
# createTime: string, format: google-datetime, readOnly
# endTime: string, format: google-datetime, readOnly
# statusDetail: string, readOnly
# target: string, readOnly
# verb: string, readOnly
# --- PauseJobRequest (0 fields) [IN MANIFEST] ---
# Request message for PauseJob.
# [[types]]
# schema = "PauseJobRequest"
# --- PubsubMessage (5 fields) ---
# A message that is published by publishers and consumed by subscribers. The message must contain eith
# WARNING: format:"byte" fields: data
# [[types]]
# schema = "PubsubMessage"
# include_fields = ["attributes", "data", "messageId", "orderingKey", "publishTime"]
#
# attributes: map<string, string>
# data: string, format: byte
# messageId: string
# orderingKey: string
# publishTime: string, format: google-datetime
#
# [types.field_overrides]
# data = { format = "bytes" }
# --- PubsubTarget (3 fields) [IN MANIFEST] ---
# Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
# WARNING: format:"byte" fields: data
# [[types]]
# schema = "PubsubTarget"
# include_fields = ["attributes", "data", "topicName"]
#
# attributes: map<string, string>
# data: string, format: byte
# topicName: string
#
# [types.field_overrides]
# data = { format = "bytes" }
# --- ResumeJobRequest (0 fields) [IN MANIFEST] ---
# Request message for ResumeJob.
# [[types]]
# schema = "ResumeJobRequest"
# --- RetryConfig (5 fields) [IN MANIFEST] ---
# Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/c
# [[types]]
# schema = "RetryConfig"
# include_fields = ["maxBackoffDuration", "maxDoublings", "maxRetryDuration", "minBackoffDuration", "retryCount"]
#
# maxBackoffDuration: string, format: google-duration
# maxDoublings: integer, format: int32
# maxRetryDuration: string, format: google-duration
# minBackoffDuration: string, format: google-duration
# retryCount: integer, format: int32
# --- RunJobRequest (0 fields) [IN MANIFEST] ---
# Request message for forcing a job to run now using RunJob.
# [[types]]
# schema = "RunJobRequest"
# --- Status (3 fields) [IN MANIFEST] ---
# The `Status` type defines a logical error model that is suitable for different programming environme
# [[types]]
# schema = "Status"
# include_fields = ["code", "details", "message"]
#
# code: integer, format: int32
# details: array<object>
# message: string
# ======================================================================
# OPERATIONS (16 total)
# ======================================================================
# --- projects.locations.getCmekConfig ---
# GET v1/{+name}
# Gets the Scheduler config in the project/region.
# Response: CmekConfig
# [[operations]]
# discovery_method = "projects.locations.getCmekConfig"
# rust_name = "getCmekConfig_projects.location"
# --- projects.locations.list ---
# GET v1/{+name}/locations
# Lists information about the supported locations for this service.
# Response: ListLocationsResponse
# Query params: extraLocationTypes (repeated), filter, pageSize, pageToken
# [[operations]]
# discovery_method = "projects.locations.list"
# rust_name = "list_projects.locations"
# list_response = { type_name = "ListLocationsResponse", items_field = "locations", item_type = "Location" }
# query_params = ["extraLocationTypes", "filter", "pageSize", "pageToken"]
# --- projects.locations.updateCmekConfig ---
# PATCH v1/{+name}
# Initializes or Updates the a scheduler config.
# Request: CmekConfig
# Response: Operation
# Query params: updateMask
# [[operations]]
# discovery_method = "projects.locations.updateCmekConfig"
# rust_name = "updateCmekConfig_projects.location"
# is_lro = true
# query_params = ["updateMask"]
# --- projects.locations.get ---
# GET v1/{+name}
# Gets information about a location.
# Response: Location
# [[operations]]
# discovery_method = "projects.locations.get"
# rust_name = "get_projects.location"
# --- projects.locations.jobs.list [IN MANIFEST] ---
# GET v1/{+parent}/jobs
# Lists jobs.
# Response: ListJobsResponse
# Query params: pageSize, pageToken
# [[operations]]
# discovery_method = "projects.locations.jobs.list"
# rust_name = "list_projects.locations.jobs"
# list_response = { type_name = "ListJobsResponse", items_field = "jobs", item_type = "Job" }
# query_params = ["pageSize", "pageToken"]
# --- projects.locations.jobs.delete [IN MANIFEST] ---
# DELETE v1/{+name}
# Deletes a job.
# Response: Empty
# [[operations]]
# discovery_method = "projects.locations.jobs.delete"
# rust_name = "delete_projects.locations.job"
# --- projects.locations.jobs.get [IN MANIFEST] ---
# GET v1/{+name}
# Gets a job.
# Response: Job
# [[operations]]
# discovery_method = "projects.locations.jobs.get"
# rust_name = "get_projects.locations.job"
# --- projects.locations.jobs.create [IN MANIFEST] ---
# POST v1/{+parent}/jobs
# Creates a job.
# Request: Job
# Response: Job
# [[operations]]
# discovery_method = "projects.locations.jobs.create"
# rust_name = "create_projects.locations.job"
# --- projects.locations.jobs.patch [IN MANIFEST] ---
# PATCH v1/{+name}
# Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is
# Request: Job
# Response: Job
# Query params: updateMask
# [[operations]]
# discovery_method = "projects.locations.jobs.patch"
# rust_name = "update_projects.locations.job"
# query_params = ["updateMask"]
# --- projects.locations.jobs.resume [IN MANIFEST] ---
# POST v1/{+name}:resume
# Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is
# Request: ResumeJobRequest
# Response: Job
# [[operations]]
# discovery_method = "projects.locations.jobs.resume"
# rust_name = "resume_projects.locations.job"
# --- projects.locations.jobs.run [IN MANIFEST] ---
# POST v1/{+name}:run
# Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if
# Request: RunJobRequest
# Response: Job
# [[operations]]
# discovery_method = "projects.locations.jobs.run"
# rust_name = "run_projects.locations.job"
# --- projects.locations.jobs.pause [IN MANIFEST] ---
# POST v1/{+name}:pause
# Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled
# Request: PauseJobRequest
# Response: Job
# [[operations]]
# discovery_method = "projects.locations.jobs.pause"
# rust_name = "pause_projects.locations.job"
# --- projects.locations.operations.list ---
# GET v1/{+name}/operations
# Lists operations that match the specified filter in the request. If the server doesn't support this
# Response: ListOperationsResponse
# Query params: filter, pageSize, pageToken, returnPartialSuccess
# [[operations]]
# discovery_method = "projects.locations.operations.list"
# rust_name = "list_projects.locations.operations"
# list_response = { type_name = "ListOperationsResponse", items_field = "operations", item_type = "Operation" }
# query_params = ["filter", "pageSize", "pageToken", "returnPartialSuccess"]
# --- projects.locations.operations.delete ---
# DELETE v1/{+name}
# Deletes a long-running operation. This method indicates that the client is no longer interested in t
# Response: Empty
# [[operations]]
# discovery_method = "projects.locations.operations.delete"
# rust_name = "delete_projects.locations.operation"
# --- projects.locations.operations.cancel ---
# POST v1/{+name}:cancel
# Starts asynchronous cancellation on a long-running operation. The server makes a best effort to canc
# Request: CancelOperationRequest
# Response: Empty
# [[operations]]
# discovery_method = "projects.locations.operations.cancel"
# rust_name = "cancel_projects.locations.operation"
# --- projects.locations.operations.get ---
# GET v1/{+name}
# Gets the latest state of a long-running operation. Clients can use this method to poll the operation
# Response: Operation
# [[operations]]
# discovery_method = "projects.locations.operations.get"
# rust_name = "get_projects.locations.operation"
# is_lro = true
# ======================================================================
# COVERAGE SUMMARY
# ======================================================================
# Schemas in discovery: 22
# Schemas in manifest: 13
# Coverage: 13/22 (59%)
#
# Operations in discovery: 16
# Operations in manifest: 8
# Coverage: 8/16 (50%)
#
# format:"byte" fields in manifest types: 3
# Unhandled (missing format="bytes"): 0