@maxim_mazurok/gapi.client.cloudscheduler-v1 0.1.20260304 → 0.2.20260522
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +76 -55
- package/package.json +1 -1
- package/readme.md +17 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudscheduler.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260522
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -33,10 +33,18 @@ declare namespace gapi.client {
|
|
|
33
33
|
appEngineRouting?: AppEngineRouting;
|
|
34
34
|
/** 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. */
|
|
35
35
|
body?: string;
|
|
36
|
-
/** 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 `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. */
|
|
36
|
+
/** 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 `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. Remains constant across retries and can be used for [job request deduplication](https://docs.cloud.google.com/scheduler/docs/overview#job-deduplication). If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. */
|
|
37
37
|
headers?: {[P in string]: string};
|
|
38
38
|
/** The HTTP method to use for the request. PATCH and OPTIONS are not permitted. */
|
|
39
|
-
httpMethod?:
|
|
39
|
+
httpMethod?:
|
|
40
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
41
|
+
| 'POST'
|
|
42
|
+
| 'GET'
|
|
43
|
+
| 'HEAD'
|
|
44
|
+
| 'PUT'
|
|
45
|
+
| 'DELETE'
|
|
46
|
+
| 'PATCH'
|
|
47
|
+
| 'OPTIONS';
|
|
40
48
|
/** 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. */
|
|
41
49
|
relativeUri?: string;
|
|
42
50
|
}
|
|
@@ -61,10 +69,18 @@ declare namespace gapi.client {
|
|
|
61
69
|
interface HttpTarget {
|
|
62
70
|
/** 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. */
|
|
63
71
|
body?: string;
|
|
64
|
-
/** HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are 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
|
|
72
|
+
/** HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are 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-*`: Used internally by Google. If present in an external user request, it is replaced by the internal header. * `X-AppEngine-*`: Used internally by Google. If present in an external user request, it is replaced by the internal header. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. Remains constant across retries and can be used for [job request deduplication](https://docs.cloud.google.com/scheduler/docs/overview#job-deduplication). If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB. */
|
|
65
73
|
headers?: {[P in string]: string};
|
|
66
74
|
/** Which HTTP method to use for the request. */
|
|
67
|
-
httpMethod?:
|
|
75
|
+
httpMethod?:
|
|
76
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
77
|
+
| 'POST'
|
|
78
|
+
| 'GET'
|
|
79
|
+
| 'HEAD'
|
|
80
|
+
| 'PUT'
|
|
81
|
+
| 'DELETE'
|
|
82
|
+
| 'PATCH'
|
|
83
|
+
| 'OPTIONS';
|
|
68
84
|
/** 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. */
|
|
69
85
|
oauthToken?: OAuthToken;
|
|
70
86
|
/** 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. */
|
|
@@ -96,7 +112,12 @@ declare namespace gapi.client {
|
|
|
96
112
|
/** 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. */
|
|
97
113
|
scheduleTime?: string;
|
|
98
114
|
/** Output only. State of the job. */
|
|
99
|
-
state?:
|
|
115
|
+
state?:
|
|
116
|
+
| 'STATE_UNSPECIFIED'
|
|
117
|
+
| 'ENABLED'
|
|
118
|
+
| 'PAUSED'
|
|
119
|
+
| 'DISABLED'
|
|
120
|
+
| 'UPDATE_FAILED';
|
|
100
121
|
/** Output only. The response from the target for the last attempted execution. */
|
|
101
122
|
status?: Status;
|
|
102
123
|
/** 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). */
|
|
@@ -215,7 +236,7 @@ declare namespace gapi.client {
|
|
|
215
236
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
216
237
|
code?: number;
|
|
217
238
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
218
|
-
details?:
|
|
239
|
+
details?: {[P in string]: any}[];
|
|
219
240
|
/** 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. */
|
|
220
241
|
message?: string;
|
|
221
242
|
}
|
|
@@ -223,11 +244,11 @@ declare namespace gapi.client {
|
|
|
223
244
|
/** Creates a job. */
|
|
224
245
|
create(request: {
|
|
225
246
|
/** V1 error format. */
|
|
226
|
-
'$.xgafv'?:
|
|
247
|
+
'$.xgafv'?: '1' | '2';
|
|
227
248
|
/** OAuth access token. */
|
|
228
249
|
access_token?: string;
|
|
229
250
|
/** Data format for response. */
|
|
230
|
-
alt?:
|
|
251
|
+
alt?: 'json' | 'media' | 'proto';
|
|
231
252
|
/** JSONP */
|
|
232
253
|
callback?: string;
|
|
233
254
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -252,11 +273,11 @@ declare namespace gapi.client {
|
|
|
252
273
|
create(
|
|
253
274
|
request: {
|
|
254
275
|
/** V1 error format. */
|
|
255
|
-
'$.xgafv'?:
|
|
276
|
+
'$.xgafv'?: '1' | '2';
|
|
256
277
|
/** OAuth access token. */
|
|
257
278
|
access_token?: string;
|
|
258
279
|
/** Data format for response. */
|
|
259
|
-
alt?:
|
|
280
|
+
alt?: 'json' | 'media' | 'proto';
|
|
260
281
|
/** JSONP */
|
|
261
282
|
callback?: string;
|
|
262
283
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -281,11 +302,11 @@ declare namespace gapi.client {
|
|
|
281
302
|
/** Deletes a job. */
|
|
282
303
|
delete(request?: {
|
|
283
304
|
/** V1 error format. */
|
|
284
|
-
'$.xgafv'?:
|
|
305
|
+
'$.xgafv'?: '1' | '2';
|
|
285
306
|
/** OAuth access token. */
|
|
286
307
|
access_token?: string;
|
|
287
308
|
/** Data format for response. */
|
|
288
|
-
alt?:
|
|
309
|
+
alt?: 'json' | 'media' | 'proto';
|
|
289
310
|
/** JSONP */
|
|
290
311
|
callback?: string;
|
|
291
312
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -308,11 +329,11 @@ declare namespace gapi.client {
|
|
|
308
329
|
/** Gets a job. */
|
|
309
330
|
get(request?: {
|
|
310
331
|
/** V1 error format. */
|
|
311
|
-
'$.xgafv'?:
|
|
332
|
+
'$.xgafv'?: '1' | '2';
|
|
312
333
|
/** OAuth access token. */
|
|
313
334
|
access_token?: string;
|
|
314
335
|
/** Data format for response. */
|
|
315
|
-
alt?:
|
|
336
|
+
alt?: 'json' | 'media' | 'proto';
|
|
316
337
|
/** JSONP */
|
|
317
338
|
callback?: string;
|
|
318
339
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -335,11 +356,11 @@ declare namespace gapi.client {
|
|
|
335
356
|
/** Lists jobs. */
|
|
336
357
|
list(request?: {
|
|
337
358
|
/** V1 error format. */
|
|
338
|
-
'$.xgafv'?:
|
|
359
|
+
'$.xgafv'?: '1' | '2';
|
|
339
360
|
/** OAuth access token. */
|
|
340
361
|
access_token?: string;
|
|
341
362
|
/** Data format for response. */
|
|
342
|
-
alt?:
|
|
363
|
+
alt?: 'json' | 'media' | 'proto';
|
|
343
364
|
/** JSONP */
|
|
344
365
|
callback?: string;
|
|
345
366
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -366,11 +387,11 @@ declare namespace gapi.client {
|
|
|
366
387
|
/** Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. */
|
|
367
388
|
patch(request: {
|
|
368
389
|
/** V1 error format. */
|
|
369
|
-
'$.xgafv'?:
|
|
390
|
+
'$.xgafv'?: '1' | '2';
|
|
370
391
|
/** OAuth access token. */
|
|
371
392
|
access_token?: string;
|
|
372
393
|
/** Data format for response. */
|
|
373
|
-
alt?:
|
|
394
|
+
alt?: 'json' | 'media' | 'proto';
|
|
374
395
|
/** JSONP */
|
|
375
396
|
callback?: string;
|
|
376
397
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -397,11 +418,11 @@ declare namespace gapi.client {
|
|
|
397
418
|
patch(
|
|
398
419
|
request: {
|
|
399
420
|
/** V1 error format. */
|
|
400
|
-
'$.xgafv'?:
|
|
421
|
+
'$.xgafv'?: '1' | '2';
|
|
401
422
|
/** OAuth access token. */
|
|
402
423
|
access_token?: string;
|
|
403
424
|
/** Data format for response. */
|
|
404
|
-
alt?:
|
|
425
|
+
alt?: 'json' | 'media' | 'proto';
|
|
405
426
|
/** JSONP */
|
|
406
427
|
callback?: string;
|
|
407
428
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -428,11 +449,11 @@ declare namespace gapi.client {
|
|
|
428
449
|
/** Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. */
|
|
429
450
|
pause(request: {
|
|
430
451
|
/** V1 error format. */
|
|
431
|
-
'$.xgafv'?:
|
|
452
|
+
'$.xgafv'?: '1' | '2';
|
|
432
453
|
/** OAuth access token. */
|
|
433
454
|
access_token?: string;
|
|
434
455
|
/** Data format for response. */
|
|
435
|
-
alt?:
|
|
456
|
+
alt?: 'json' | 'media' | 'proto';
|
|
436
457
|
/** JSONP */
|
|
437
458
|
callback?: string;
|
|
438
459
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -457,11 +478,11 @@ declare namespace gapi.client {
|
|
|
457
478
|
pause(
|
|
458
479
|
request: {
|
|
459
480
|
/** V1 error format. */
|
|
460
|
-
'$.xgafv'?:
|
|
481
|
+
'$.xgafv'?: '1' | '2';
|
|
461
482
|
/** OAuth access token. */
|
|
462
483
|
access_token?: string;
|
|
463
484
|
/** Data format for response. */
|
|
464
|
-
alt?:
|
|
485
|
+
alt?: 'json' | 'media' | 'proto';
|
|
465
486
|
/** JSONP */
|
|
466
487
|
callback?: string;
|
|
467
488
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -486,11 +507,11 @@ declare namespace gapi.client {
|
|
|
486
507
|
/** Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. */
|
|
487
508
|
resume(request: {
|
|
488
509
|
/** V1 error format. */
|
|
489
|
-
'$.xgafv'?:
|
|
510
|
+
'$.xgafv'?: '1' | '2';
|
|
490
511
|
/** OAuth access token. */
|
|
491
512
|
access_token?: string;
|
|
492
513
|
/** Data format for response. */
|
|
493
|
-
alt?:
|
|
514
|
+
alt?: 'json' | 'media' | 'proto';
|
|
494
515
|
/** JSONP */
|
|
495
516
|
callback?: string;
|
|
496
517
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -515,11 +536,11 @@ declare namespace gapi.client {
|
|
|
515
536
|
resume(
|
|
516
537
|
request: {
|
|
517
538
|
/** V1 error format. */
|
|
518
|
-
'$.xgafv'?:
|
|
539
|
+
'$.xgafv'?: '1' | '2';
|
|
519
540
|
/** OAuth access token. */
|
|
520
541
|
access_token?: string;
|
|
521
542
|
/** Data format for response. */
|
|
522
|
-
alt?:
|
|
543
|
+
alt?: 'json' | 'media' | 'proto';
|
|
523
544
|
/** JSONP */
|
|
524
545
|
callback?: string;
|
|
525
546
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -544,11 +565,11 @@ declare namespace gapi.client {
|
|
|
544
565
|
/** Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. */
|
|
545
566
|
run(request: {
|
|
546
567
|
/** V1 error format. */
|
|
547
|
-
'$.xgafv'?:
|
|
568
|
+
'$.xgafv'?: '1' | '2';
|
|
548
569
|
/** OAuth access token. */
|
|
549
570
|
access_token?: string;
|
|
550
571
|
/** Data format for response. */
|
|
551
|
-
alt?:
|
|
572
|
+
alt?: 'json' | 'media' | 'proto';
|
|
552
573
|
/** JSONP */
|
|
553
574
|
callback?: string;
|
|
554
575
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -573,11 +594,11 @@ declare namespace gapi.client {
|
|
|
573
594
|
run(
|
|
574
595
|
request: {
|
|
575
596
|
/** V1 error format. */
|
|
576
|
-
'$.xgafv'?:
|
|
597
|
+
'$.xgafv'?: '1' | '2';
|
|
577
598
|
/** OAuth access token. */
|
|
578
599
|
access_token?: string;
|
|
579
600
|
/** Data format for response. */
|
|
580
|
-
alt?:
|
|
601
|
+
alt?: 'json' | 'media' | 'proto';
|
|
581
602
|
/** JSONP */
|
|
582
603
|
callback?: string;
|
|
583
604
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -604,11 +625,11 @@ declare namespace gapi.client {
|
|
|
604
625
|
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
605
626
|
cancel(request: {
|
|
606
627
|
/** V1 error format. */
|
|
607
|
-
'$.xgafv'?:
|
|
628
|
+
'$.xgafv'?: '1' | '2';
|
|
608
629
|
/** OAuth access token. */
|
|
609
630
|
access_token?: string;
|
|
610
631
|
/** Data format for response. */
|
|
611
|
-
alt?:
|
|
632
|
+
alt?: 'json' | 'media' | 'proto';
|
|
612
633
|
/** JSONP */
|
|
613
634
|
callback?: string;
|
|
614
635
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -633,11 +654,11 @@ declare namespace gapi.client {
|
|
|
633
654
|
cancel(
|
|
634
655
|
request: {
|
|
635
656
|
/** V1 error format. */
|
|
636
|
-
'$.xgafv'?:
|
|
657
|
+
'$.xgafv'?: '1' | '2';
|
|
637
658
|
/** OAuth access token. */
|
|
638
659
|
access_token?: string;
|
|
639
660
|
/** Data format for response. */
|
|
640
|
-
alt?:
|
|
661
|
+
alt?: 'json' | 'media' | 'proto';
|
|
641
662
|
/** JSONP */
|
|
642
663
|
callback?: string;
|
|
643
664
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -662,11 +683,11 @@ declare namespace gapi.client {
|
|
|
662
683
|
/** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
|
|
663
684
|
delete(request?: {
|
|
664
685
|
/** V1 error format. */
|
|
665
|
-
'$.xgafv'?:
|
|
686
|
+
'$.xgafv'?: '1' | '2';
|
|
666
687
|
/** OAuth access token. */
|
|
667
688
|
access_token?: string;
|
|
668
689
|
/** Data format for response. */
|
|
669
|
-
alt?:
|
|
690
|
+
alt?: 'json' | 'media' | 'proto';
|
|
670
691
|
/** JSONP */
|
|
671
692
|
callback?: string;
|
|
672
693
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -689,11 +710,11 @@ declare namespace gapi.client {
|
|
|
689
710
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
690
711
|
get(request?: {
|
|
691
712
|
/** V1 error format. */
|
|
692
|
-
'$.xgafv'?:
|
|
713
|
+
'$.xgafv'?: '1' | '2';
|
|
693
714
|
/** OAuth access token. */
|
|
694
715
|
access_token?: string;
|
|
695
716
|
/** Data format for response. */
|
|
696
|
-
alt?:
|
|
717
|
+
alt?: 'json' | 'media' | 'proto';
|
|
697
718
|
/** JSONP */
|
|
698
719
|
callback?: string;
|
|
699
720
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -716,11 +737,11 @@ declare namespace gapi.client {
|
|
|
716
737
|
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
717
738
|
list(request?: {
|
|
718
739
|
/** V1 error format. */
|
|
719
|
-
'$.xgafv'?:
|
|
740
|
+
'$.xgafv'?: '1' | '2';
|
|
720
741
|
/** OAuth access token. */
|
|
721
742
|
access_token?: string;
|
|
722
743
|
/** Data format for response. */
|
|
723
|
-
alt?:
|
|
744
|
+
alt?: 'json' | 'media' | 'proto';
|
|
724
745
|
/** JSONP */
|
|
725
746
|
callback?: string;
|
|
726
747
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -753,11 +774,11 @@ declare namespace gapi.client {
|
|
|
753
774
|
/** Gets information about a location. */
|
|
754
775
|
get(request?: {
|
|
755
776
|
/** V1 error format. */
|
|
756
|
-
'$.xgafv'?:
|
|
777
|
+
'$.xgafv'?: '1' | '2';
|
|
757
778
|
/** OAuth access token. */
|
|
758
779
|
access_token?: string;
|
|
759
780
|
/** Data format for response. */
|
|
760
|
-
alt?:
|
|
781
|
+
alt?: 'json' | 'media' | 'proto';
|
|
761
782
|
/** JSONP */
|
|
762
783
|
callback?: string;
|
|
763
784
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -780,11 +801,11 @@ declare namespace gapi.client {
|
|
|
780
801
|
/** Gets the Scheduler config in the project/region. */
|
|
781
802
|
getCmekConfig(request?: {
|
|
782
803
|
/** V1 error format. */
|
|
783
|
-
'$.xgafv'?:
|
|
804
|
+
'$.xgafv'?: '1' | '2';
|
|
784
805
|
/** OAuth access token. */
|
|
785
806
|
access_token?: string;
|
|
786
807
|
/** Data format for response. */
|
|
787
|
-
alt?:
|
|
808
|
+
alt?: 'json' | 'media' | 'proto';
|
|
788
809
|
/** JSONP */
|
|
789
810
|
callback?: string;
|
|
790
811
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -804,17 +825,17 @@ declare namespace gapi.client {
|
|
|
804
825
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
805
826
|
uploadType?: string;
|
|
806
827
|
}): Request<CmekConfig>;
|
|
807
|
-
/** Lists information about the supported locations for this service. This method
|
|
828
|
+
/** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
|
|
808
829
|
list(request?: {
|
|
809
830
|
/** V1 error format. */
|
|
810
|
-
'$.xgafv'?:
|
|
831
|
+
'$.xgafv'?: '1' | '2';
|
|
811
832
|
/** OAuth access token. */
|
|
812
833
|
access_token?: string;
|
|
813
834
|
/** Data format for response. */
|
|
814
|
-
alt?:
|
|
835
|
+
alt?: 'json' | 'media' | 'proto';
|
|
815
836
|
/** JSONP */
|
|
816
837
|
callback?: string;
|
|
817
|
-
/** Optional. Do not use this field
|
|
838
|
+
/** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
818
839
|
extraLocationTypes?: string | string[];
|
|
819
840
|
/** Selector specifying which fields to include in a partial response. */
|
|
820
841
|
fields?: string;
|
|
@@ -842,11 +863,11 @@ declare namespace gapi.client {
|
|
|
842
863
|
/** Initializes or Updates the a scheduler config. */
|
|
843
864
|
updateCmekConfig(request: {
|
|
844
865
|
/** V1 error format. */
|
|
845
|
-
'$.xgafv'?:
|
|
866
|
+
'$.xgafv'?: '1' | '2';
|
|
846
867
|
/** OAuth access token. */
|
|
847
868
|
access_token?: string;
|
|
848
869
|
/** Data format for response. */
|
|
849
|
-
alt?:
|
|
870
|
+
alt?: 'json' | 'media' | 'proto';
|
|
850
871
|
/** JSONP */
|
|
851
872
|
callback?: string;
|
|
852
873
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -873,11 +894,11 @@ declare namespace gapi.client {
|
|
|
873
894
|
updateCmekConfig(
|
|
874
895
|
request: {
|
|
875
896
|
/** V1 error format. */
|
|
876
|
-
'$.xgafv'?:
|
|
897
|
+
'$.xgafv'?: '1' | '2';
|
|
877
898
|
/** OAuth access token. */
|
|
878
899
|
access_token?: string;
|
|
879
900
|
/** Data format for response. */
|
|
880
|
-
alt?:
|
|
901
|
+
alt?: 'json' | 'media' | 'proto';
|
|
881
902
|
/** JSONP */
|
|
882
903
|
callback?: string;
|
|
883
904
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Cloud Scheduler API:
|
|
|
11
11
|
npm install @types/gapi.client.cloudscheduler-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.cloudscheduler-v1"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|