@maxim_mazurok/gapi.client.cloudscheduler-v1beta1 0.1.20260304 → 0.2.20260304

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.
Files changed (2) hide show
  1. package/index.d.ts +64 -43
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -36,7 +36,15 @@ declare namespace gapi.client {
36
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. */
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?: string;
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
  }
@@ -58,7 +66,15 @@ declare namespace gapi.client {
58
66
  /** 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 use only. * `X-AppEngine-*`: Google internal use only. * `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 total size of headers must be less than 80KB. */
59
67
  headers?: {[P in string]: string};
60
68
  /** Which HTTP method to use for the request. */
61
- httpMethod?: string;
69
+ httpMethod?:
70
+ | 'HTTP_METHOD_UNSPECIFIED'
71
+ | 'POST'
72
+ | 'GET'
73
+ | 'HEAD'
74
+ | 'PUT'
75
+ | 'DELETE'
76
+ | 'PATCH'
77
+ | 'OPTIONS';
62
78
  /** 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. */
63
79
  oauthToken?: OAuthToken;
64
80
  /** 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. */
@@ -92,7 +108,12 @@ declare namespace gapi.client {
92
108
  /** 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. */
93
109
  scheduleTime?: string;
94
110
  /** Output only. State of the job. */
95
- state?: string;
111
+ state?:
112
+ | 'STATE_UNSPECIFIED'
113
+ | 'ENABLED'
114
+ | 'PAUSED'
115
+ | 'DISABLED'
116
+ | 'UPDATE_FAILED';
96
117
  /** Output only. The response from the target for the last attempted execution. */
97
118
  status?: Status;
98
119
  /** 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). */
@@ -222,11 +243,11 @@ declare namespace gapi.client {
222
243
  /** Creates a job. */
223
244
  create(request: {
224
245
  /** V1 error format. */
225
- '$.xgafv'?: string;
246
+ '$.xgafv'?: '1' | '2';
226
247
  /** OAuth access token. */
227
248
  access_token?: string;
228
249
  /** Data format for response. */
229
- alt?: string;
250
+ alt?: 'json' | 'media' | 'proto';
230
251
  /** JSONP */
231
252
  callback?: string;
232
253
  /** Selector specifying which fields to include in a partial response. */
@@ -251,11 +272,11 @@ declare namespace gapi.client {
251
272
  create(
252
273
  request: {
253
274
  /** V1 error format. */
254
- '$.xgafv'?: string;
275
+ '$.xgafv'?: '1' | '2';
255
276
  /** OAuth access token. */
256
277
  access_token?: string;
257
278
  /** Data format for response. */
258
- alt?: string;
279
+ alt?: 'json' | 'media' | 'proto';
259
280
  /** JSONP */
260
281
  callback?: string;
261
282
  /** Selector specifying which fields to include in a partial response. */
@@ -280,11 +301,11 @@ declare namespace gapi.client {
280
301
  /** Deletes a job. */
281
302
  delete(request?: {
282
303
  /** V1 error format. */
283
- '$.xgafv'?: string;
304
+ '$.xgafv'?: '1' | '2';
284
305
  /** OAuth access token. */
285
306
  access_token?: string;
286
307
  /** Data format for response. */
287
- alt?: string;
308
+ alt?: 'json' | 'media' | 'proto';
288
309
  /** JSONP */
289
310
  callback?: string;
290
311
  /** Selector specifying which fields to include in a partial response. */
@@ -309,11 +330,11 @@ declare namespace gapi.client {
309
330
  /** Gets a job. */
310
331
  get(request?: {
311
332
  /** V1 error format. */
312
- '$.xgafv'?: string;
333
+ '$.xgafv'?: '1' | '2';
313
334
  /** OAuth access token. */
314
335
  access_token?: string;
315
336
  /** Data format for response. */
316
- alt?: string;
337
+ alt?: 'json' | 'media' | 'proto';
317
338
  /** JSONP */
318
339
  callback?: string;
319
340
  /** Selector specifying which fields to include in a partial response. */
@@ -336,11 +357,11 @@ declare namespace gapi.client {
336
357
  /** Lists jobs. */
337
358
  list(request?: {
338
359
  /** V1 error format. */
339
- '$.xgafv'?: string;
360
+ '$.xgafv'?: '1' | '2';
340
361
  /** OAuth access token. */
341
362
  access_token?: string;
342
363
  /** Data format for response. */
343
- alt?: string;
364
+ alt?: 'json' | 'media' | 'proto';
344
365
  /** JSONP */
345
366
  callback?: string;
346
367
  /** Selector specifying which fields to include in a partial response. */
@@ -371,11 +392,11 @@ declare namespace gapi.client {
371
392
  /** 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. */
372
393
  patch(request: {
373
394
  /** V1 error format. */
374
- '$.xgafv'?: string;
395
+ '$.xgafv'?: '1' | '2';
375
396
  /** OAuth access token. */
376
397
  access_token?: string;
377
398
  /** Data format for response. */
378
- alt?: string;
399
+ alt?: 'json' | 'media' | 'proto';
379
400
  /** JSONP */
380
401
  callback?: string;
381
402
  /** Selector specifying which fields to include in a partial response. */
@@ -402,11 +423,11 @@ declare namespace gapi.client {
402
423
  patch(
403
424
  request: {
404
425
  /** V1 error format. */
405
- '$.xgafv'?: string;
426
+ '$.xgafv'?: '1' | '2';
406
427
  /** OAuth access token. */
407
428
  access_token?: string;
408
429
  /** Data format for response. */
409
- alt?: string;
430
+ alt?: 'json' | 'media' | 'proto';
410
431
  /** JSONP */
411
432
  callback?: string;
412
433
  /** Selector specifying which fields to include in a partial response. */
@@ -433,11 +454,11 @@ declare namespace gapi.client {
433
454
  /** 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. */
434
455
  pause(request: {
435
456
  /** V1 error format. */
436
- '$.xgafv'?: string;
457
+ '$.xgafv'?: '1' | '2';
437
458
  /** OAuth access token. */
438
459
  access_token?: string;
439
460
  /** Data format for response. */
440
- alt?: string;
461
+ alt?: 'json' | 'media' | 'proto';
441
462
  /** JSONP */
442
463
  callback?: string;
443
464
  /** Selector specifying which fields to include in a partial response. */
@@ -462,11 +483,11 @@ declare namespace gapi.client {
462
483
  pause(
463
484
  request: {
464
485
  /** V1 error format. */
465
- '$.xgafv'?: string;
486
+ '$.xgafv'?: '1' | '2';
466
487
  /** OAuth access token. */
467
488
  access_token?: string;
468
489
  /** Data format for response. */
469
- alt?: string;
490
+ alt?: 'json' | 'media' | 'proto';
470
491
  /** JSONP */
471
492
  callback?: string;
472
493
  /** Selector specifying which fields to include in a partial response. */
@@ -491,11 +512,11 @@ declare namespace gapi.client {
491
512
  /** 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. */
492
513
  resume(request: {
493
514
  /** V1 error format. */
494
- '$.xgafv'?: string;
515
+ '$.xgafv'?: '1' | '2';
495
516
  /** OAuth access token. */
496
517
  access_token?: string;
497
518
  /** Data format for response. */
498
- alt?: string;
519
+ alt?: 'json' | 'media' | 'proto';
499
520
  /** JSONP */
500
521
  callback?: string;
501
522
  /** Selector specifying which fields to include in a partial response. */
@@ -520,11 +541,11 @@ declare namespace gapi.client {
520
541
  resume(
521
542
  request: {
522
543
  /** V1 error format. */
523
- '$.xgafv'?: string;
544
+ '$.xgafv'?: '1' | '2';
524
545
  /** OAuth access token. */
525
546
  access_token?: string;
526
547
  /** Data format for response. */
527
- alt?: string;
548
+ alt?: 'json' | 'media' | 'proto';
528
549
  /** JSONP */
529
550
  callback?: string;
530
551
  /** Selector specifying which fields to include in a partial response. */
@@ -549,11 +570,11 @@ declare namespace gapi.client {
549
570
  /** Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. */
550
571
  run(request: {
551
572
  /** V1 error format. */
552
- '$.xgafv'?: string;
573
+ '$.xgafv'?: '1' | '2';
553
574
  /** OAuth access token. */
554
575
  access_token?: string;
555
576
  /** Data format for response. */
556
- alt?: string;
577
+ alt?: 'json' | 'media' | 'proto';
557
578
  /** JSONP */
558
579
  callback?: string;
559
580
  /** Selector specifying which fields to include in a partial response. */
@@ -578,11 +599,11 @@ declare namespace gapi.client {
578
599
  run(
579
600
  request: {
580
601
  /** V1 error format. */
581
- '$.xgafv'?: string;
602
+ '$.xgafv'?: '1' | '2';
582
603
  /** OAuth access token. */
583
604
  access_token?: string;
584
605
  /** Data format for response. */
585
- alt?: string;
606
+ alt?: 'json' | 'media' | 'proto';
586
607
  /** JSONP */
587
608
  callback?: string;
588
609
  /** Selector specifying which fields to include in a partial response. */
@@ -609,11 +630,11 @@ declare namespace gapi.client {
609
630
  /** 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`. */
610
631
  cancel(request: {
611
632
  /** V1 error format. */
612
- '$.xgafv'?: string;
633
+ '$.xgafv'?: '1' | '2';
613
634
  /** OAuth access token. */
614
635
  access_token?: string;
615
636
  /** Data format for response. */
616
- alt?: string;
637
+ alt?: 'json' | 'media' | 'proto';
617
638
  /** JSONP */
618
639
  callback?: string;
619
640
  /** Selector specifying which fields to include in a partial response. */
@@ -638,11 +659,11 @@ declare namespace gapi.client {
638
659
  cancel(
639
660
  request: {
640
661
  /** V1 error format. */
641
- '$.xgafv'?: string;
662
+ '$.xgafv'?: '1' | '2';
642
663
  /** OAuth access token. */
643
664
  access_token?: string;
644
665
  /** Data format for response. */
645
- alt?: string;
666
+ alt?: 'json' | 'media' | 'proto';
646
667
  /** JSONP */
647
668
  callback?: string;
648
669
  /** Selector specifying which fields to include in a partial response. */
@@ -667,11 +688,11 @@ declare namespace gapi.client {
667
688
  /** 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`. */
668
689
  delete(request?: {
669
690
  /** V1 error format. */
670
- '$.xgafv'?: string;
691
+ '$.xgafv'?: '1' | '2';
671
692
  /** OAuth access token. */
672
693
  access_token?: string;
673
694
  /** Data format for response. */
674
- alt?: string;
695
+ alt?: 'json' | 'media' | 'proto';
675
696
  /** JSONP */
676
697
  callback?: string;
677
698
  /** Selector specifying which fields to include in a partial response. */
@@ -694,11 +715,11 @@ declare namespace gapi.client {
694
715
  /** 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. */
695
716
  get(request?: {
696
717
  /** V1 error format. */
697
- '$.xgafv'?: string;
718
+ '$.xgafv'?: '1' | '2';
698
719
  /** OAuth access token. */
699
720
  access_token?: string;
700
721
  /** Data format for response. */
701
- alt?: string;
722
+ alt?: 'json' | 'media' | 'proto';
702
723
  /** JSONP */
703
724
  callback?: string;
704
725
  /** Selector specifying which fields to include in a partial response. */
@@ -721,11 +742,11 @@ declare namespace gapi.client {
721
742
  /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
722
743
  list(request?: {
723
744
  /** V1 error format. */
724
- '$.xgafv'?: string;
745
+ '$.xgafv'?: '1' | '2';
725
746
  /** OAuth access token. */
726
747
  access_token?: string;
727
748
  /** Data format for response. */
728
- alt?: string;
749
+ alt?: 'json' | 'media' | 'proto';
729
750
  /** JSONP */
730
751
  callback?: string;
731
752
  /** Selector specifying which fields to include in a partial response. */
@@ -758,11 +779,11 @@ declare namespace gapi.client {
758
779
  /** Gets information about a location. */
759
780
  get(request?: {
760
781
  /** V1 error format. */
761
- '$.xgafv'?: string;
782
+ '$.xgafv'?: '1' | '2';
762
783
  /** OAuth access token. */
763
784
  access_token?: string;
764
785
  /** Data format for response. */
765
- alt?: string;
786
+ alt?: 'json' | 'media' | 'proto';
766
787
  /** JSONP */
767
788
  callback?: string;
768
789
  /** Selector specifying which fields to include in a partial response. */
@@ -785,11 +806,11 @@ declare namespace gapi.client {
785
806
  /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
786
807
  list(request?: {
787
808
  /** V1 error format. */
788
- '$.xgafv'?: string;
809
+ '$.xgafv'?: '1' | '2';
789
810
  /** OAuth access token. */
790
811
  access_token?: string;
791
812
  /** Data format for response. */
792
- alt?: string;
813
+ alt?: 'json' | 'media' | 'proto';
793
814
  /** JSONP */
794
815
  callback?: string;
795
816
  /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.cloudscheduler-v1beta1",
3
- "version": "0.1.20260304",
3
+ "version": "0.2.20260304",
4
4
  "description": "TypeScript typings for Cloud Scheduler API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",