/
cloudscheduler-gen.go
2030 lines (1894 loc) · 80.5 KB
/
cloudscheduler-gen.go
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
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package cloudscheduler provides access to the Cloud Scheduler API.
//
// For product documentation, see: https://cloud.google.com/scheduler/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/cloudscheduler/v1"
// ...
// ctx := context.Background()
// cloudschedulerService, err := cloudscheduler.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// cloudschedulerService, err := cloudscheduler.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// cloudschedulerService, err := cloudscheduler.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package cloudscheduler // import "google.golang.org/api/cloudscheduler/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "cloudscheduler:v1"
const apiName = "cloudscheduler"
const apiVersion = "v1"
const basePath = "https://cloudscheduler.googleapis.com/"
const basePathTemplate = "https://cloudscheduler.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://cloudscheduler.mtls.googleapis.com/"
const defaultUniverseDomain = "googleapis.com"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.WithDefaultUniverseDomain(defaultUniverseDomain))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Locations = NewProjectsLocationsService(s)
return rs
}
type ProjectsService struct {
s *Service
Locations *ProjectsLocationsService
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
rs := &ProjectsLocationsService{s: s}
rs.Jobs = NewProjectsLocationsJobsService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
Jobs *ProjectsLocationsJobsService
}
func NewProjectsLocationsJobsService(s *Service) *ProjectsLocationsJobsService {
rs := &ProjectsLocationsJobsService{s: s}
return rs
}
type ProjectsLocationsJobsService struct {
s *Service
}
// AppEngineHttpTarget: App Engine target. The job will be pushed to a job
// handler by means of an HTTP request via an http_method such as HTTP POST,
// HTTP GET, etc. The job is acknowledged by means of an HTTP response code in
// the range [200 - 299]. Error 503 is considered an App Engine system error
// instead of an application error. Requests returning error 503 will be
// retried regardless of retry configuration and not counted against retry
// counts. Any other response code, or a failure to receive a response before
// the deadline, constitutes a failed attempt.
type AppEngineHttpTarget struct {
// AppEngineRouting: App Engine Routing setting for the job.
AppEngineRouting *AppEngineRouting `json:"appEngineRouting,omitempty"`
// Body: 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.
Body string `json:"body,omitempty"`
// Headers: 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.
Headers map[string]string `json:"headers,omitempty"`
// HttpMethod: The HTTP method to use for the request. PATCH and OPTIONS are
// not permitted.
//
// Possible values:
// "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified. Defaults to POST.
// "POST" - HTTP POST
// "GET" - HTTP GET
// "HEAD" - HTTP HEAD
// "PUT" - HTTP PUT
// "DELETE" - HTTP DELETE
// "PATCH" - HTTP PATCH
// "OPTIONS" - HTTP OPTIONS
HttpMethod string `json:"httpMethod,omitempty"`
// RelativeUri: 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.
RelativeUri string `json:"relativeUri,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppEngineRouting") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppEngineRouting") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppEngineHttpTarget) MarshalJSON() ([]byte, error) {
type NoMethod AppEngineHttpTarget
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AppEngineRouting: App Engine Routing. For more information about services,
// versions, and instances see An Overview of App Engine
// (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
// Microservices Architecture on Google App Engine
// (https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
// 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 AppEngineRouting struct {
// Host: 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.
Host string `json:"host,omitempty"`
// Instance: 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?#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).
Instance string `json:"instance,omitempty"`
// Service: App service. By default, the job is sent to the service which is
// the default service when the job is attempted.
Service string `json:"service,omitempty"`
// Version: App version. By default, the job is sent to the version which is
// the default version when the job is attempted.
Version string `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "Host") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Host") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppEngineRouting) MarshalJSON() ([]byte, error) {
type NoMethod AppEngineRouting
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Empty: A generic empty message that you can re-use to avoid defining
// duplicated empty messages in your APIs. A typical example is to use it as
// the request or the response type of an API method. For instance: service Foo
// { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
// HttpTarget: Http target. The job will be pushed to the job handler by means
// of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The
// job is acknowledged by means of an HTTP response code in the range [200 -
// 299]. A failure to receive a response constitutes a failed execution. For a
// redirected request, the response returned by the redirected request is
// considered.
type HttpTarget struct {
// Body: 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.
Body string `json:"body,omitempty"`
// Headers: 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.
Headers map[string]string `json:"headers,omitempty"`
// HttpMethod: Which HTTP method to use for the request.
//
// Possible values:
// "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified. Defaults to POST.
// "POST" - HTTP POST
// "GET" - HTTP GET
// "HEAD" - HTTP HEAD
// "PUT" - HTTP PUT
// "DELETE" - HTTP DELETE
// "PATCH" - HTTP PATCH
// "OPTIONS" - HTTP OPTIONS
HttpMethod string `json:"httpMethod,omitempty"`
// OauthToken: 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.
OauthToken *OAuthToken `json:"oauthToken,omitempty"`
// OidcToken: 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.
OidcToken *OidcToken `json:"oidcToken,omitempty"`
// Uri: 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.
Uri string `json:"uri,omitempty"`
// ForceSendFields is a list of field names (e.g. "Body") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Body") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *HttpTarget) MarshalJSON() ([]byte, error) {
type NoMethod HttpTarget
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Job: Configuration for a job. The maximum allowed size for a job is 1MB.
type Job struct {
// AppEngineHttpTarget: App Engine HTTP target.
AppEngineHttpTarget *AppEngineHttpTarget `json:"appEngineHttpTarget,omitempty"`
// AttemptDeadline: 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 default and the allowed values depend on the type of
// target: * For HTTP targets, the default is 3 minutes. The deadline must be
// in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0
// indicates that the request has the default deadline. The default deadline
// depends on the scaling type of the service: 10 minutes for standard apps
// with automatic scaling, 24 hours for standard apps with manual and basic
// scaling, and 60 minutes for flex apps. If the request deadline is set, it
// must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub
// targets, this field is ignored.
AttemptDeadline string `json:"attemptDeadline,omitempty"`
// Description: Optionally caller-specified in CreateJob or UpdateJob. A
// human-readable description for the job. This string must not contain more
// than 500 characters.
Description string `json:"description,omitempty"`
// HttpTarget: HTTP target.
HttpTarget *HttpTarget `json:"httpTarget,omitempty"`
// LastAttemptTime: Output only. The time the last job attempt started.
LastAttemptTime string `json:"lastAttemptTime,omitempty"`
// Name: Optionally caller-specified in CreateJob, after which it becomes
// output only. The job name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can
// contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or
// periods (.). For more information, see Identifying projects
// (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
// * `LOCATION_ID` is the canonical ID for the job's location. The list of
// available locations can be obtained by calling ListLocations. For more
// information, see https://cloud.google.com/about/locations/. * `JOB_ID` can
// contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or
// underscores (_). The maximum length is 500 characters.
Name string `json:"name,omitempty"`
// PubsubTarget: Pub/Sub target.
PubsubTarget *PubsubTarget `json:"pubsubTarget,omitempty"`
// RetryConfig: Settings that determine the retry behavior.
RetryConfig *RetryConfig `json:"retryConfig,omitempty"`
// Schedule: 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 (https://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. If retry_count is 0, a job attempt will not
// be retried if it fails. Instead the Cloud Scheduler system will wait for the
// next scheduled execution time. Setting retry_count to 0 does not prevent
// failed jobs from running according to schedule after the failure.
Schedule string `json:"schedule,omitempty"`
// ScheduleTime: 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.
ScheduleTime string `json:"scheduleTime,omitempty"`
// State: Output only. State of the job.
//
// Possible values:
// "STATE_UNSPECIFIED" - Unspecified state.
// "ENABLED" - The job is executing normally.
// "PAUSED" - The job is paused by the user. It will not execute. A user can
// intentionally pause the job using PauseJobRequest.
// "DISABLED" - The job is disabled by the system due to error. The user
// cannot directly set a job to be disabled.
// "UPDATE_FAILED" - The job state resulting from a failed
// CloudScheduler.UpdateJob operation. To recover a job from this state, retry
// CloudScheduler.UpdateJob until a successful response is received.
State string `json:"state,omitempty"`
// Status: Output only. The response from the target for the last attempted
// execution.
Status *Status `json:"status,omitempty"`
// TimeZone: 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).
TimeZone string `json:"timeZone,omitempty"`
// UserUpdateTime: Output only. The creation time of the job.
UserUpdateTime string `json:"userUpdateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AppEngineHttpTarget") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppEngineHttpTarget") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Job) MarshalJSON() ([]byte, error) {
type NoMethod Job
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ListJobsResponse: Response message for listing jobs using ListJobs.
type ListJobsResponse struct {
// Jobs: The list of jobs.
Jobs []*Job `json:"jobs,omitempty"`
// NextPageToken: A token to retrieve next page of results. Pass this value in
// the page_token field in the subsequent call to ListJobs to retrieve the next
// page of results. If this is empty it indicates that there are no more
// results through which to paginate. The page token is valid for only 2 hours.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Jobs") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Jobs") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListJobsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListJobsResponse
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ListLocationsResponse: The response message for Locations.ListLocations.
type ListLocationsResponse struct {
// Locations: A list of locations that matches the specified filter in the
// request.
Locations []*Location `json:"locations,omitempty"`
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Locations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Locations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListLocationsResponse
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Location: A resource that represents a Google Cloud location.
type Location struct {
// DisplayName: The friendly name for this location, typically a nearby city
// name. For example, "Tokyo".
DisplayName string `json:"displayName,omitempty"`
// Labels: Cross-service attributes for the location. For example
// {"cloud.googleapis.com/region": "us-east1"}
Labels map[string]string `json:"labels,omitempty"`
// LocationId: The canonical id for this location. For example: "us-east1".
LocationId string `json:"locationId,omitempty"`
// Metadata: Service-specific metadata. For example the available capacity at
// the given location.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: Resource name for the location, which may vary between
// implementations. For example:
// "projects/example-project/locations/us-east1"
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Location) MarshalJSON() ([]byte, error) {
type NoMethod Location
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// OAuthToken: Contains information needed for generating an OAuth token
// (https://developers.google.com/identity/protocols/OAuth2). This type of
// authorization should generally only be used when calling Google APIs hosted
// on *.googleapis.com.
type OAuthToken struct {
// Scope: OAuth scope to be used for generating OAuth access token. If not
// specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
Scope string `json:"scope,omitempty"`
// ServiceAccountEmail: 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.
ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
// ForceSendFields is a list of field names (e.g. "Scope") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Scope") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OAuthToken) MarshalJSON() ([]byte, error) {
type NoMethod OAuthToken
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// OidcToken: Contains information needed for generating an OpenID Connect
// token (https://developers.google.com/identity/protocols/OpenIDConnect). This
// type of authorization can be used for many scenarios, including calling
// Cloud Run, or endpoints where you intend to validate the token yourself.
type OidcToken struct {
// Audience: Audience to be used when generating OIDC token. If not specified,
// the URI specified in target will be used.
Audience string `json:"audience,omitempty"`
// ServiceAccountEmail: 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.
ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
// ForceSendFields is a list of field names (e.g. "Audience") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Audience") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OidcToken) MarshalJSON() ([]byte, error) {
type NoMethod OidcToken
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// PauseJobRequest: Request message for PauseJob.
type PauseJobRequest struct {
}
// PubsubMessage: A message that is published by publishers and consumed by
// subscribers. The message must contain either a non-empty data field or at
// least one attribute. Note that client libraries represent this object
// differently depending on the language. See the corresponding client library
// documentation (https://cloud.google.com/pubsub/docs/reference/libraries) for
// more information. See [quotas and limits]
// (https://cloud.google.com/pubsub/quotas) for more information about message
// limits.
type PubsubMessage struct {
// Attributes: Optional. Attributes for this message. If this field is empty,
// the message must contain non-empty data. This can be used to filter messages
// on the subscription.
Attributes map[string]string `json:"attributes,omitempty"`
// Data: Optional. The message data field. If this field is empty, the message
// must contain at least one attribute.
Data string `json:"data,omitempty"`
// MessageId: ID of this message, assigned by the server when the message is
// published. Guaranteed to be unique within the topic. This value may be read
// by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
// delivery. It must not be populated by the publisher in a `Publish` call.
MessageId string `json:"messageId,omitempty"`
// OrderingKey: Optional. If non-empty, identifies related messages for which
// publish order should be respected. If a `Subscription` has
// `enable_message_ordering` set to `true`, messages published with the same
// non-empty `ordering_key` value will be delivered to subscribers in the order
// in which they are received by the Pub/Sub system. All `PubsubMessage`s
// published in a given `PublishRequest` must specify the same `ordering_key`
// value. For more information, see ordering messages
// (https://cloud.google.com/pubsub/docs/ordering).
OrderingKey string `json:"orderingKey,omitempty"`
// PublishTime: The time at which the message was published, populated by the
// server when it receives the `Publish` call. It must not be populated by the
// publisher in a `Publish` call.
PublishTime string `json:"publishTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "Attributes") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Attributes") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PubsubMessage) MarshalJSON() ([]byte, error) {
type NoMethod PubsubMessage
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// PubsubTarget: Pub/Sub target. The job will be delivered by publishing a
// message to the given Pub/Sub topic.
type PubsubTarget struct {
// Attributes: Attributes for PubsubMessage. Pubsub message must contain either
// non-empty data, or at least one attribute.
Attributes map[string]string `json:"attributes,omitempty"`
// Data: The message payload for PubsubMessage. Pubsub message must contain
// either non-empty data, or at least one attribute.
Data string `json:"data,omitempty"`
// TopicName: 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.
TopicName string `json:"topicName,omitempty"`
// ForceSendFields is a list of field names (e.g. "Attributes") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Attributes") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PubsubTarget) MarshalJSON() ([]byte, error) {
type NoMethod PubsubTarget
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ResumeJobRequest: Request message for ResumeJob.
type ResumeJobRequest struct {
}
// RetryConfig: Settings that determine the retry behavior. By default, if a
// job does not complete successfully (meaning that an acknowledgement is not
// received from the handler, then it will be retried with exponential backoff
// according to the settings in RetryConfig.
type RetryConfig struct {
// MaxBackoffDuration: The maximum amount of time to wait before retrying a job
// after it fails. The default value of this field is 1 hour.
MaxBackoffDuration string `json:"maxBackoffDuration,omitempty"`
// MaxDoublings: 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 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.
MaxDoublings int64 `json:"maxDoublings,omitempty"`
// MaxRetryDuration: 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.
MaxRetryDuration string `json:"maxRetryDuration,omitempty"`
// MinBackoffDuration: The minimum amount of time to wait before retrying a job
// after it fails. The default value of this field is 5 seconds.
MinBackoffDuration string `json:"minBackoffDuration,omitempty"`
// RetryCount: 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 0, a job attempt
// will not be retried if it fails. Instead the Cloud Scheduler system will
// wait for the next scheduled execution time. Setting retry_count to 0 does
// not prevent failed jobs from running according to schedule after the
// failure. 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.
RetryCount int64 `json:"retryCount,omitempty"`
// ForceSendFields is a list of field names (e.g. "MaxBackoffDuration") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MaxBackoffDuration") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RetryConfig) MarshalJSON() ([]byte, error) {
type NoMethod RetryConfig
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// RunJobRequest: Request message for forcing a job to run now using RunJob.
type RunJobRequest struct {
}
// Status: The `Status` type defines a logical error model that is suitable for
// different programming environments, including REST APIs and RPC APIs. It is
// used by gRPC (https://github.com/grpc). Each `Status` message contains three
// pieces of data: error code, error message, and error details. You can find
// out more about this error model and how to work with it in the API Design
// Guide (https://cloud.google.com/apis/design/errors).
type Status struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: 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.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error) {
type NoMethod Status
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
type ProjectsLocationsGetCall struct {
s *Service
name string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// Get: Gets information about a location.
//
// - name: Resource name for the location.
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall {
c := &ProjectsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *ProjectsLocationsGetCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *ProjectsLocationsGetCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
var body io.Reader = nil
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"name": c.name,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "cloudscheduler.projects.locations.get" call.
// Any non-2xx status code is an error. Response headers are in either
// *Location.ServerResponse.Header or (if a response was returned at all) in
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
// whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &Location{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
}
type ProjectsLocationsListCall struct {
s *Service
name string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// List: Lists information about the supported locations for this service.
//
// - name: The resource that owns the locations collection, if applicable.
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall {