/
pulumiTypes.go
1756 lines (1440 loc) · 118 KB
/
pulumiTypes.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
// Code generated by the Pulumi SDK Generator DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package v1
import (
"context"
"reflect"
"github.com/pulumi/pulumi-google-native/sdk/go/google/internal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
var _ = internal.GetEnvOrDefault
// 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 {
// App Engine Routing setting for the job.
AppEngineRouting *AppEngineRouting `pulumi:"appEngineRouting"`
// 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 `pulumi:"body"`
// 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 time in RFC3339 UTC "Zulu" format. 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 `pulumi:"headers"`
// The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
HttpMethod *AppEngineHttpTargetHttpMethod `pulumi:"httpMethod"`
// 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 `pulumi:"relativeUri"`
}
// AppEngineHttpTargetInput is an input type that accepts AppEngineHttpTargetArgs and AppEngineHttpTargetOutput values.
// You can construct a concrete instance of `AppEngineHttpTargetInput` via:
//
// AppEngineHttpTargetArgs{...}
type AppEngineHttpTargetInput interface {
pulumi.Input
ToAppEngineHttpTargetOutput() AppEngineHttpTargetOutput
ToAppEngineHttpTargetOutputWithContext(context.Context) AppEngineHttpTargetOutput
}
// 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 AppEngineHttpTargetArgs struct {
// App Engine Routing setting for the job.
AppEngineRouting AppEngineRoutingPtrInput `pulumi:"appEngineRouting"`
// 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 pulumi.StringPtrInput `pulumi:"body"`
// 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 time in RFC3339 UTC "Zulu" format. 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 pulumi.StringMapInput `pulumi:"headers"`
// The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
HttpMethod AppEngineHttpTargetHttpMethodPtrInput `pulumi:"httpMethod"`
// 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 pulumi.StringPtrInput `pulumi:"relativeUri"`
}
func (AppEngineHttpTargetArgs) ElementType() reflect.Type {
return reflect.TypeOf((*AppEngineHttpTarget)(nil)).Elem()
}
func (i AppEngineHttpTargetArgs) ToAppEngineHttpTargetOutput() AppEngineHttpTargetOutput {
return i.ToAppEngineHttpTargetOutputWithContext(context.Background())
}
func (i AppEngineHttpTargetArgs) ToAppEngineHttpTargetOutputWithContext(ctx context.Context) AppEngineHttpTargetOutput {
return pulumi.ToOutputWithContext(ctx, i).(AppEngineHttpTargetOutput)
}
func (i AppEngineHttpTargetArgs) ToAppEngineHttpTargetPtrOutput() AppEngineHttpTargetPtrOutput {
return i.ToAppEngineHttpTargetPtrOutputWithContext(context.Background())
}
func (i AppEngineHttpTargetArgs) ToAppEngineHttpTargetPtrOutputWithContext(ctx context.Context) AppEngineHttpTargetPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(AppEngineHttpTargetOutput).ToAppEngineHttpTargetPtrOutputWithContext(ctx)
}
// AppEngineHttpTargetPtrInput is an input type that accepts AppEngineHttpTargetArgs, AppEngineHttpTargetPtr and AppEngineHttpTargetPtrOutput values.
// You can construct a concrete instance of `AppEngineHttpTargetPtrInput` via:
//
// AppEngineHttpTargetArgs{...}
//
// or:
//
// nil
type AppEngineHttpTargetPtrInput interface {
pulumi.Input
ToAppEngineHttpTargetPtrOutput() AppEngineHttpTargetPtrOutput
ToAppEngineHttpTargetPtrOutputWithContext(context.Context) AppEngineHttpTargetPtrOutput
}
type appEngineHttpTargetPtrType AppEngineHttpTargetArgs
func AppEngineHttpTargetPtr(v *AppEngineHttpTargetArgs) AppEngineHttpTargetPtrInput {
return (*appEngineHttpTargetPtrType)(v)
}
func (*appEngineHttpTargetPtrType) ElementType() reflect.Type {
return reflect.TypeOf((**AppEngineHttpTarget)(nil)).Elem()
}
func (i *appEngineHttpTargetPtrType) ToAppEngineHttpTargetPtrOutput() AppEngineHttpTargetPtrOutput {
return i.ToAppEngineHttpTargetPtrOutputWithContext(context.Background())
}
func (i *appEngineHttpTargetPtrType) ToAppEngineHttpTargetPtrOutputWithContext(ctx context.Context) AppEngineHttpTargetPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(AppEngineHttpTargetPtrOutput)
}
// 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 AppEngineHttpTargetOutput struct{ *pulumi.OutputState }
func (AppEngineHttpTargetOutput) ElementType() reflect.Type {
return reflect.TypeOf((*AppEngineHttpTarget)(nil)).Elem()
}
func (o AppEngineHttpTargetOutput) ToAppEngineHttpTargetOutput() AppEngineHttpTargetOutput {
return o
}
func (o AppEngineHttpTargetOutput) ToAppEngineHttpTargetOutputWithContext(ctx context.Context) AppEngineHttpTargetOutput {
return o
}
func (o AppEngineHttpTargetOutput) ToAppEngineHttpTargetPtrOutput() AppEngineHttpTargetPtrOutput {
return o.ToAppEngineHttpTargetPtrOutputWithContext(context.Background())
}
func (o AppEngineHttpTargetOutput) ToAppEngineHttpTargetPtrOutputWithContext(ctx context.Context) AppEngineHttpTargetPtrOutput {
return o.ApplyTWithContext(ctx, func(_ context.Context, v AppEngineHttpTarget) *AppEngineHttpTarget {
return &v
}).(AppEngineHttpTargetPtrOutput)
}
// App Engine Routing setting for the job.
func (o AppEngineHttpTargetOutput) AppEngineRouting() AppEngineRoutingPtrOutput {
return o.ApplyT(func(v AppEngineHttpTarget) *AppEngineRouting { return v.AppEngineRouting }).(AppEngineRoutingPtrOutput)
}
// 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.
func (o AppEngineHttpTargetOutput) Body() pulumi.StringPtrOutput {
return o.ApplyT(func(v AppEngineHttpTarget) *string { return v.Body }).(pulumi.StringPtrOutput)
}
// 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 time in RFC3339 UTC "Zulu" format. 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.
func (o AppEngineHttpTargetOutput) Headers() pulumi.StringMapOutput {
return o.ApplyT(func(v AppEngineHttpTarget) map[string]string { return v.Headers }).(pulumi.StringMapOutput)
}
// The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
func (o AppEngineHttpTargetOutput) HttpMethod() AppEngineHttpTargetHttpMethodPtrOutput {
return o.ApplyT(func(v AppEngineHttpTarget) *AppEngineHttpTargetHttpMethod { return v.HttpMethod }).(AppEngineHttpTargetHttpMethodPtrOutput)
}
// 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.
func (o AppEngineHttpTargetOutput) RelativeUri() pulumi.StringPtrOutput {
return o.ApplyT(func(v AppEngineHttpTarget) *string { return v.RelativeUri }).(pulumi.StringPtrOutput)
}
type AppEngineHttpTargetPtrOutput struct{ *pulumi.OutputState }
func (AppEngineHttpTargetPtrOutput) ElementType() reflect.Type {
return reflect.TypeOf((**AppEngineHttpTarget)(nil)).Elem()
}
func (o AppEngineHttpTargetPtrOutput) ToAppEngineHttpTargetPtrOutput() AppEngineHttpTargetPtrOutput {
return o
}
func (o AppEngineHttpTargetPtrOutput) ToAppEngineHttpTargetPtrOutputWithContext(ctx context.Context) AppEngineHttpTargetPtrOutput {
return o
}
func (o AppEngineHttpTargetPtrOutput) Elem() AppEngineHttpTargetOutput {
return o.ApplyT(func(v *AppEngineHttpTarget) AppEngineHttpTarget {
if v != nil {
return *v
}
var ret AppEngineHttpTarget
return ret
}).(AppEngineHttpTargetOutput)
}
// App Engine Routing setting for the job.
func (o AppEngineHttpTargetPtrOutput) AppEngineRouting() AppEngineRoutingPtrOutput {
return o.ApplyT(func(v *AppEngineHttpTarget) *AppEngineRouting {
if v == nil {
return nil
}
return v.AppEngineRouting
}).(AppEngineRoutingPtrOutput)
}
// 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.
func (o AppEngineHttpTargetPtrOutput) Body() pulumi.StringPtrOutput {
return o.ApplyT(func(v *AppEngineHttpTarget) *string {
if v == nil {
return nil
}
return v.Body
}).(pulumi.StringPtrOutput)
}
// 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 time in RFC3339 UTC "Zulu" format. 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.
func (o AppEngineHttpTargetPtrOutput) Headers() pulumi.StringMapOutput {
return o.ApplyT(func(v *AppEngineHttpTarget) map[string]string {
if v == nil {
return nil
}
return v.Headers
}).(pulumi.StringMapOutput)
}
// The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
func (o AppEngineHttpTargetPtrOutput) HttpMethod() AppEngineHttpTargetHttpMethodPtrOutput {
return o.ApplyT(func(v *AppEngineHttpTarget) *AppEngineHttpTargetHttpMethod {
if v == nil {
return nil
}
return v.HttpMethod
}).(AppEngineHttpTargetHttpMethodPtrOutput)
}
// 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.
func (o AppEngineHttpTargetPtrOutput) RelativeUri() pulumi.StringPtrOutput {
return o.ApplyT(func(v *AppEngineHttpTarget) *string {
if v == nil {
return nil
}
return v.RelativeUri
}).(pulumi.StringPtrOutput)
}
// 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 AppEngineHttpTargetResponse struct {
// App Engine Routing setting for the job.
AppEngineRouting AppEngineRoutingResponse `pulumi:"appEngineRouting"`
// 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 `pulumi:"body"`
// 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 time in RFC3339 UTC "Zulu" format. 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 `pulumi:"headers"`
// The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
HttpMethod string `pulumi:"httpMethod"`
// 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 `pulumi:"relativeUri"`
}
// 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 AppEngineHttpTargetResponseOutput struct{ *pulumi.OutputState }
func (AppEngineHttpTargetResponseOutput) ElementType() reflect.Type {
return reflect.TypeOf((*AppEngineHttpTargetResponse)(nil)).Elem()
}
func (o AppEngineHttpTargetResponseOutput) ToAppEngineHttpTargetResponseOutput() AppEngineHttpTargetResponseOutput {
return o
}
func (o AppEngineHttpTargetResponseOutput) ToAppEngineHttpTargetResponseOutputWithContext(ctx context.Context) AppEngineHttpTargetResponseOutput {
return o
}
// App Engine Routing setting for the job.
func (o AppEngineHttpTargetResponseOutput) AppEngineRouting() AppEngineRoutingResponseOutput {
return o.ApplyT(func(v AppEngineHttpTargetResponse) AppEngineRoutingResponse { return v.AppEngineRouting }).(AppEngineRoutingResponseOutput)
}
// 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.
func (o AppEngineHttpTargetResponseOutput) Body() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineHttpTargetResponse) string { return v.Body }).(pulumi.StringOutput)
}
// 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 time in RFC3339 UTC "Zulu" format. 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.
func (o AppEngineHttpTargetResponseOutput) Headers() pulumi.StringMapOutput {
return o.ApplyT(func(v AppEngineHttpTargetResponse) map[string]string { return v.Headers }).(pulumi.StringMapOutput)
}
// The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
func (o AppEngineHttpTargetResponseOutput) HttpMethod() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineHttpTargetResponse) string { return v.HttpMethod }).(pulumi.StringOutput)
}
// 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.
func (o AppEngineHttpTargetResponseOutput) RelativeUri() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineHttpTargetResponse) string { return v.RelativeUri }).(pulumi.StringOutput)
}
// 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 {
// 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 `pulumi:"instance"`
// App service. By default, the job is sent to the service which is the default service when the job is attempted.
Service *string `pulumi:"service"`
// App version. By default, the job is sent to the version which is the default version when the job is attempted.
Version *string `pulumi:"version"`
}
// AppEngineRoutingInput is an input type that accepts AppEngineRoutingArgs and AppEngineRoutingOutput values.
// You can construct a concrete instance of `AppEngineRoutingInput` via:
//
// AppEngineRoutingArgs{...}
type AppEngineRoutingInput interface {
pulumi.Input
ToAppEngineRoutingOutput() AppEngineRoutingOutput
ToAppEngineRoutingOutputWithContext(context.Context) AppEngineRoutingOutput
}
// 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 AppEngineRoutingArgs struct {
// 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 pulumi.StringPtrInput `pulumi:"instance"`
// App service. By default, the job is sent to the service which is the default service when the job is attempted.
Service pulumi.StringPtrInput `pulumi:"service"`
// App version. By default, the job is sent to the version which is the default version when the job is attempted.
Version pulumi.StringPtrInput `pulumi:"version"`
}
func (AppEngineRoutingArgs) ElementType() reflect.Type {
return reflect.TypeOf((*AppEngineRouting)(nil)).Elem()
}
func (i AppEngineRoutingArgs) ToAppEngineRoutingOutput() AppEngineRoutingOutput {
return i.ToAppEngineRoutingOutputWithContext(context.Background())
}
func (i AppEngineRoutingArgs) ToAppEngineRoutingOutputWithContext(ctx context.Context) AppEngineRoutingOutput {
return pulumi.ToOutputWithContext(ctx, i).(AppEngineRoutingOutput)
}
func (i AppEngineRoutingArgs) ToAppEngineRoutingPtrOutput() AppEngineRoutingPtrOutput {
return i.ToAppEngineRoutingPtrOutputWithContext(context.Background())
}
func (i AppEngineRoutingArgs) ToAppEngineRoutingPtrOutputWithContext(ctx context.Context) AppEngineRoutingPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(AppEngineRoutingOutput).ToAppEngineRoutingPtrOutputWithContext(ctx)
}
// AppEngineRoutingPtrInput is an input type that accepts AppEngineRoutingArgs, AppEngineRoutingPtr and AppEngineRoutingPtrOutput values.
// You can construct a concrete instance of `AppEngineRoutingPtrInput` via:
//
// AppEngineRoutingArgs{...}
//
// or:
//
// nil
type AppEngineRoutingPtrInput interface {
pulumi.Input
ToAppEngineRoutingPtrOutput() AppEngineRoutingPtrOutput
ToAppEngineRoutingPtrOutputWithContext(context.Context) AppEngineRoutingPtrOutput
}
type appEngineRoutingPtrType AppEngineRoutingArgs
func AppEngineRoutingPtr(v *AppEngineRoutingArgs) AppEngineRoutingPtrInput {
return (*appEngineRoutingPtrType)(v)
}
func (*appEngineRoutingPtrType) ElementType() reflect.Type {
return reflect.TypeOf((**AppEngineRouting)(nil)).Elem()
}
func (i *appEngineRoutingPtrType) ToAppEngineRoutingPtrOutput() AppEngineRoutingPtrOutput {
return i.ToAppEngineRoutingPtrOutputWithContext(context.Background())
}
func (i *appEngineRoutingPtrType) ToAppEngineRoutingPtrOutputWithContext(ctx context.Context) AppEngineRoutingPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(AppEngineRoutingPtrOutput)
}
// 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 AppEngineRoutingOutput struct{ *pulumi.OutputState }
func (AppEngineRoutingOutput) ElementType() reflect.Type {
return reflect.TypeOf((*AppEngineRouting)(nil)).Elem()
}
func (o AppEngineRoutingOutput) ToAppEngineRoutingOutput() AppEngineRoutingOutput {
return o
}
func (o AppEngineRoutingOutput) ToAppEngineRoutingOutputWithContext(ctx context.Context) AppEngineRoutingOutput {
return o
}
func (o AppEngineRoutingOutput) ToAppEngineRoutingPtrOutput() AppEngineRoutingPtrOutput {
return o.ToAppEngineRoutingPtrOutputWithContext(context.Background())
}
func (o AppEngineRoutingOutput) ToAppEngineRoutingPtrOutputWithContext(ctx context.Context) AppEngineRoutingPtrOutput {
return o.ApplyTWithContext(ctx, func(_ context.Context, v AppEngineRouting) *AppEngineRouting {
return &v
}).(AppEngineRoutingPtrOutput)
}
// 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).
func (o AppEngineRoutingOutput) Instance() pulumi.StringPtrOutput {
return o.ApplyT(func(v AppEngineRouting) *string { return v.Instance }).(pulumi.StringPtrOutput)
}
// App service. By default, the job is sent to the service which is the default service when the job is attempted.
func (o AppEngineRoutingOutput) Service() pulumi.StringPtrOutput {
return o.ApplyT(func(v AppEngineRouting) *string { return v.Service }).(pulumi.StringPtrOutput)
}
// App version. By default, the job is sent to the version which is the default version when the job is attempted.
func (o AppEngineRoutingOutput) Version() pulumi.StringPtrOutput {
return o.ApplyT(func(v AppEngineRouting) *string { return v.Version }).(pulumi.StringPtrOutput)
}
type AppEngineRoutingPtrOutput struct{ *pulumi.OutputState }
func (AppEngineRoutingPtrOutput) ElementType() reflect.Type {
return reflect.TypeOf((**AppEngineRouting)(nil)).Elem()
}
func (o AppEngineRoutingPtrOutput) ToAppEngineRoutingPtrOutput() AppEngineRoutingPtrOutput {
return o
}
func (o AppEngineRoutingPtrOutput) ToAppEngineRoutingPtrOutputWithContext(ctx context.Context) AppEngineRoutingPtrOutput {
return o
}
func (o AppEngineRoutingPtrOutput) Elem() AppEngineRoutingOutput {
return o.ApplyT(func(v *AppEngineRouting) AppEngineRouting {
if v != nil {
return *v
}
var ret AppEngineRouting
return ret
}).(AppEngineRoutingOutput)
}
// 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).
func (o AppEngineRoutingPtrOutput) Instance() pulumi.StringPtrOutput {
return o.ApplyT(func(v *AppEngineRouting) *string {
if v == nil {
return nil
}
return v.Instance
}).(pulumi.StringPtrOutput)
}
// App service. By default, the job is sent to the service which is the default service when the job is attempted.
func (o AppEngineRoutingPtrOutput) Service() pulumi.StringPtrOutput {
return o.ApplyT(func(v *AppEngineRouting) *string {
if v == nil {
return nil
}
return v.Service
}).(pulumi.StringPtrOutput)
}
// App version. By default, the job is sent to the version which is the default version when the job is attempted.
func (o AppEngineRoutingPtrOutput) Version() pulumi.StringPtrOutput {
return o.ApplyT(func(v *AppEngineRouting) *string {
if v == nil {
return nil
}
return v.Version
}).(pulumi.StringPtrOutput)
}
// 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 AppEngineRoutingResponse struct {
// 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 `pulumi:"host"`
// 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 `pulumi:"instance"`
// App service. By default, the job is sent to the service which is the default service when the job is attempted.
Service string `pulumi:"service"`
// App version. By default, the job is sent to the version which is the default version when the job is attempted.
Version string `pulumi:"version"`
}
// 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 AppEngineRoutingResponseOutput struct{ *pulumi.OutputState }
func (AppEngineRoutingResponseOutput) ElementType() reflect.Type {
return reflect.TypeOf((*AppEngineRoutingResponse)(nil)).Elem()
}
func (o AppEngineRoutingResponseOutput) ToAppEngineRoutingResponseOutput() AppEngineRoutingResponseOutput {
return o
}
func (o AppEngineRoutingResponseOutput) ToAppEngineRoutingResponseOutputWithContext(ctx context.Context) AppEngineRoutingResponseOutput {
return o
}
// 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.
func (o AppEngineRoutingResponseOutput) Host() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineRoutingResponse) string { return v.Host }).(pulumi.StringOutput)
}
// 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).
func (o AppEngineRoutingResponseOutput) Instance() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineRoutingResponse) string { return v.Instance }).(pulumi.StringOutput)
}
// App service. By default, the job is sent to the service which is the default service when the job is attempted.
func (o AppEngineRoutingResponseOutput) Service() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineRoutingResponse) string { return v.Service }).(pulumi.StringOutput)
}
// App version. By default, the job is sent to the version which is the default version when the job is attempted.
func (o AppEngineRoutingResponseOutput) Version() pulumi.StringOutput {
return o.ApplyT(func(v AppEngineRoutingResponse) string { return v.Version }).(pulumi.StringOutput)
}
// 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 {
// 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 `pulumi:"body"`
// 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 time in RFC3339 UTC "Zulu" format. 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 `pulumi:"headers"`
// Which HTTP method to use for the request.
HttpMethod *HttpTargetHttpMethod `pulumi:"httpMethod"`
// 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 `pulumi:"oauthToken"`
// 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 `pulumi:"oidcToken"`
// 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 `pulumi:"uri"`
}
// HttpTargetInput is an input type that accepts HttpTargetArgs and HttpTargetOutput values.
// You can construct a concrete instance of `HttpTargetInput` via:
//
// HttpTargetArgs{...}
type HttpTargetInput interface {
pulumi.Input
ToHttpTargetOutput() HttpTargetOutput
ToHttpTargetOutputWithContext(context.Context) HttpTargetOutput
}
// 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 HttpTargetArgs struct {
// 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 pulumi.StringPtrInput `pulumi:"body"`
// 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 time in RFC3339 UTC "Zulu" format. 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 pulumi.StringMapInput `pulumi:"headers"`
// Which HTTP method to use for the request.
HttpMethod HttpTargetHttpMethodPtrInput `pulumi:"httpMethod"`
// 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 OAuthTokenPtrInput `pulumi:"oauthToken"`
// 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 OidcTokenPtrInput `pulumi:"oidcToken"`
// 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 pulumi.StringInput `pulumi:"uri"`
}
func (HttpTargetArgs) ElementType() reflect.Type {
return reflect.TypeOf((*HttpTarget)(nil)).Elem()
}
func (i HttpTargetArgs) ToHttpTargetOutput() HttpTargetOutput {
return i.ToHttpTargetOutputWithContext(context.Background())
}
func (i HttpTargetArgs) ToHttpTargetOutputWithContext(ctx context.Context) HttpTargetOutput {
return pulumi.ToOutputWithContext(ctx, i).(HttpTargetOutput)
}
func (i HttpTargetArgs) ToHttpTargetPtrOutput() HttpTargetPtrOutput {
return i.ToHttpTargetPtrOutputWithContext(context.Background())
}
func (i HttpTargetArgs) ToHttpTargetPtrOutputWithContext(ctx context.Context) HttpTargetPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(HttpTargetOutput).ToHttpTargetPtrOutputWithContext(ctx)
}
// HttpTargetPtrInput is an input type that accepts HttpTargetArgs, HttpTargetPtr and HttpTargetPtrOutput values.
// You can construct a concrete instance of `HttpTargetPtrInput` via:
//
// HttpTargetArgs{...}
//
// or:
//
// nil
type HttpTargetPtrInput interface {
pulumi.Input
ToHttpTargetPtrOutput() HttpTargetPtrOutput
ToHttpTargetPtrOutputWithContext(context.Context) HttpTargetPtrOutput
}
type httpTargetPtrType HttpTargetArgs
func HttpTargetPtr(v *HttpTargetArgs) HttpTargetPtrInput {
return (*httpTargetPtrType)(v)
}
func (*httpTargetPtrType) ElementType() reflect.Type {
return reflect.TypeOf((**HttpTarget)(nil)).Elem()
}
func (i *httpTargetPtrType) ToHttpTargetPtrOutput() HttpTargetPtrOutput {
return i.ToHttpTargetPtrOutputWithContext(context.Background())
}
func (i *httpTargetPtrType) ToHttpTargetPtrOutputWithContext(ctx context.Context) HttpTargetPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(HttpTargetPtrOutput)
}
// 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 HttpTargetOutput struct{ *pulumi.OutputState }
func (HttpTargetOutput) ElementType() reflect.Type {
return reflect.TypeOf((*HttpTarget)(nil)).Elem()
}
func (o HttpTargetOutput) ToHttpTargetOutput() HttpTargetOutput {
return o
}
func (o HttpTargetOutput) ToHttpTargetOutputWithContext(ctx context.Context) HttpTargetOutput {
return o
}
func (o HttpTargetOutput) ToHttpTargetPtrOutput() HttpTargetPtrOutput {
return o.ToHttpTargetPtrOutputWithContext(context.Background())
}
func (o HttpTargetOutput) ToHttpTargetPtrOutputWithContext(ctx context.Context) HttpTargetPtrOutput {
return o.ApplyTWithContext(ctx, func(_ context.Context, v HttpTarget) *HttpTarget {
return &v
}).(HttpTargetPtrOutput)
}
// 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.
func (o HttpTargetOutput) Body() pulumi.StringPtrOutput {
return o.ApplyT(func(v HttpTarget) *string { return v.Body }).(pulumi.StringPtrOutput)
}
// 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 time in RFC3339 UTC "Zulu" format. 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.
func (o HttpTargetOutput) Headers() pulumi.StringMapOutput {
return o.ApplyT(func(v HttpTarget) map[string]string { return v.Headers }).(pulumi.StringMapOutput)
}
// Which HTTP method to use for the request.
func (o HttpTargetOutput) HttpMethod() HttpTargetHttpMethodPtrOutput {
return o.ApplyT(func(v HttpTarget) *HttpTargetHttpMethod { return v.HttpMethod }).(HttpTargetHttpMethodPtrOutput)
}
// 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.
func (o HttpTargetOutput) OauthToken() OAuthTokenPtrOutput {
return o.ApplyT(func(v HttpTarget) *OAuthToken { return v.OauthToken }).(OAuthTokenPtrOutput)
}
// 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.
func (o HttpTargetOutput) OidcToken() OidcTokenPtrOutput {
return o.ApplyT(func(v HttpTarget) *OidcToken { return v.OidcToken }).(OidcTokenPtrOutput)
}
// 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.
func (o HttpTargetOutput) Uri() pulumi.StringOutput {
return o.ApplyT(func(v HttpTarget) string { return v.Uri }).(pulumi.StringOutput)
}
type HttpTargetPtrOutput struct{ *pulumi.OutputState }
func (HttpTargetPtrOutput) ElementType() reflect.Type {
return reflect.TypeOf((**HttpTarget)(nil)).Elem()
}
func (o HttpTargetPtrOutput) ToHttpTargetPtrOutput() HttpTargetPtrOutput {
return o
}
func (o HttpTargetPtrOutput) ToHttpTargetPtrOutputWithContext(ctx context.Context) HttpTargetPtrOutput {
return o
}
func (o HttpTargetPtrOutput) Elem() HttpTargetOutput {
return o.ApplyT(func(v *HttpTarget) HttpTarget {
if v != nil {
return *v
}
var ret HttpTarget
return ret
}).(HttpTargetOutput)
}
// 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.
func (o HttpTargetPtrOutput) Body() pulumi.StringPtrOutput {
return o.ApplyT(func(v *HttpTarget) *string {
if v == nil {
return nil
}
return v.Body
}).(pulumi.StringPtrOutput)
}
// 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 time in RFC3339 UTC "Zulu" format. 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.
func (o HttpTargetPtrOutput) Headers() pulumi.StringMapOutput {
return o.ApplyT(func(v *HttpTarget) map[string]string {
if v == nil {
return nil
}
return v.Headers
}).(pulumi.StringMapOutput)
}
// Which HTTP method to use for the request.
func (o HttpTargetPtrOutput) HttpMethod() HttpTargetHttpMethodPtrOutput {
return o.ApplyT(func(v *HttpTarget) *HttpTargetHttpMethod {
if v == nil {
return nil
}
return v.HttpMethod
}).(HttpTargetHttpMethodPtrOutput)
}
// 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.
func (o HttpTargetPtrOutput) OauthToken() OAuthTokenPtrOutput {
return o.ApplyT(func(v *HttpTarget) *OAuthToken {
if v == nil {
return nil
}
return v.OauthToken
}).(OAuthTokenPtrOutput)
}
// 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.
func (o HttpTargetPtrOutput) OidcToken() OidcTokenPtrOutput {
return o.ApplyT(func(v *HttpTarget) *OidcToken {
if v == nil {
return nil
}
return v.OidcToken
}).(OidcTokenPtrOutput)
}
// 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.
func (o HttpTargetPtrOutput) Uri() pulumi.StringPtrOutput {
return o.ApplyT(func(v *HttpTarget) *string {
if v == nil {
return nil
}
return &v.Uri
}).(pulumi.StringPtrOutput)
}
// 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 HttpTargetResponse struct {
// 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 `pulumi:"body"`
// 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 time in RFC3339 UTC "Zulu" format. 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 `pulumi:"headers"`
// Which HTTP method to use for the request.
HttpMethod string `pulumi:"httpMethod"`
// 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 OAuthTokenResponse `pulumi:"oauthToken"`
// 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 OidcTokenResponse `pulumi:"oidcToken"`
// 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 `pulumi:"uri"`
}
// 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 HttpTargetResponseOutput struct{ *pulumi.OutputState }
func (HttpTargetResponseOutput) ElementType() reflect.Type {
return reflect.TypeOf((*HttpTargetResponse)(nil)).Elem()
}
func (o HttpTargetResponseOutput) ToHttpTargetResponseOutput() HttpTargetResponseOutput {
return o
}
func (o HttpTargetResponseOutput) ToHttpTargetResponseOutputWithContext(ctx context.Context) HttpTargetResponseOutput {
return o
}
// 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.
func (o HttpTargetResponseOutput) Body() pulumi.StringOutput {
return o.ApplyT(func(v HttpTargetResponse) string { return v.Body }).(pulumi.StringOutput)
}
// 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 time in RFC3339 UTC "Zulu" format. 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.
func (o HttpTargetResponseOutput) Headers() pulumi.StringMapOutput {
return o.ApplyT(func(v HttpTargetResponse) map[string]string { return v.Headers }).(pulumi.StringMapOutput)
}
// Which HTTP method to use for the request.
func (o HttpTargetResponseOutput) HttpMethod() pulumi.StringOutput {
return o.ApplyT(func(v HttpTargetResponse) string { return v.HttpMethod }).(pulumi.StringOutput)
}
// 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.
func (o HttpTargetResponseOutput) OauthToken() OAuthTokenResponseOutput {
return o.ApplyT(func(v HttpTargetResponse) OAuthTokenResponse { return v.OauthToken }).(OAuthTokenResponseOutput)
}
// 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.
func (o HttpTargetResponseOutput) OidcToken() OidcTokenResponseOutput {
return o.ApplyT(func(v HttpTargetResponse) OidcTokenResponse { return v.OidcToken }).(OidcTokenResponseOutput)
}
// 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.
func (o HttpTargetResponseOutput) Uri() pulumi.StringOutput {
return o.ApplyT(func(v HttpTargetResponse) string { return v.Uri }).(pulumi.StringOutput)
}
// 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 {
// 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 `pulumi:"scope"`
// [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 `pulumi:"serviceAccountEmail"`
}
// OAuthTokenInput is an input type that accepts OAuthTokenArgs and OAuthTokenOutput values.
// You can construct a concrete instance of `OAuthTokenInput` via:
//
// OAuthTokenArgs{...}
type OAuthTokenInput interface {
pulumi.Input
ToOAuthTokenOutput() OAuthTokenOutput
ToOAuthTokenOutputWithContext(context.Context) OAuthTokenOutput
}
// 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 OAuthTokenArgs struct {
// OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
Scope pulumi.StringPtrInput `pulumi:"scope"`
// [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 pulumi.StringPtrInput `pulumi:"serviceAccountEmail"`
}
func (OAuthTokenArgs) ElementType() reflect.Type {
return reflect.TypeOf((*OAuthToken)(nil)).Elem()
}
func (i OAuthTokenArgs) ToOAuthTokenOutput() OAuthTokenOutput {
return i.ToOAuthTokenOutputWithContext(context.Background())
}
func (i OAuthTokenArgs) ToOAuthTokenOutputWithContext(ctx context.Context) OAuthTokenOutput {
return pulumi.ToOutputWithContext(ctx, i).(OAuthTokenOutput)
}
func (i OAuthTokenArgs) ToOAuthTokenPtrOutput() OAuthTokenPtrOutput {
return i.ToOAuthTokenPtrOutputWithContext(context.Background())
}
func (i OAuthTokenArgs) ToOAuthTokenPtrOutputWithContext(ctx context.Context) OAuthTokenPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(OAuthTokenOutput).ToOAuthTokenPtrOutputWithContext(ctx)
}
// OAuthTokenPtrInput is an input type that accepts OAuthTokenArgs, OAuthTokenPtr and OAuthTokenPtrOutput values.
// You can construct a concrete instance of `OAuthTokenPtrInput` via:
//
// OAuthTokenArgs{...}
//
// or:
//
// nil
type OAuthTokenPtrInput interface {
pulumi.Input
ToOAuthTokenPtrOutput() OAuthTokenPtrOutput
ToOAuthTokenPtrOutputWithContext(context.Context) OAuthTokenPtrOutput
}
type oauthTokenPtrType OAuthTokenArgs
func OAuthTokenPtr(v *OAuthTokenArgs) OAuthTokenPtrInput {
return (*oauthTokenPtrType)(v)
}
func (*oauthTokenPtrType) ElementType() reflect.Type {
return reflect.TypeOf((**OAuthToken)(nil)).Elem()
}
func (i *oauthTokenPtrType) ToOAuthTokenPtrOutput() OAuthTokenPtrOutput {
return i.ToOAuthTokenPtrOutputWithContext(context.Background())
}
func (i *oauthTokenPtrType) ToOAuthTokenPtrOutputWithContext(ctx context.Context) OAuthTokenPtrOutput {
return pulumi.ToOutputWithContext(ctx, i).(OAuthTokenPtrOutput)
}
// 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 OAuthTokenOutput struct{ *pulumi.OutputState }
func (OAuthTokenOutput) ElementType() reflect.Type {
return reflect.TypeOf((*OAuthToken)(nil)).Elem()
}
func (o OAuthTokenOutput) ToOAuthTokenOutput() OAuthTokenOutput {
return o
}
func (o OAuthTokenOutput) ToOAuthTokenOutputWithContext(ctx context.Context) OAuthTokenOutput {
return o
}
func (o OAuthTokenOutput) ToOAuthTokenPtrOutput() OAuthTokenPtrOutput {
return o.ToOAuthTokenPtrOutputWithContext(context.Background())
}
func (o OAuthTokenOutput) ToOAuthTokenPtrOutputWithContext(ctx context.Context) OAuthTokenPtrOutput {
return o.ApplyTWithContext(ctx, func(_ context.Context, v OAuthToken) *OAuthToken {
return &v
}).(OAuthTokenPtrOutput)
}
// OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
func (o OAuthTokenOutput) Scope() pulumi.StringPtrOutput {
return o.ApplyT(func(v OAuthToken) *string { return v.Scope }).(pulumi.StringPtrOutput)
}
// [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.
func (o OAuthTokenOutput) ServiceAccountEmail() pulumi.StringPtrOutput {
return o.ApplyT(func(v OAuthToken) *string { return v.ServiceAccountEmail }).(pulumi.StringPtrOutput)
}
type OAuthTokenPtrOutput struct{ *pulumi.OutputState }
func (OAuthTokenPtrOutput) ElementType() reflect.Type {
return reflect.TypeOf((**OAuthToken)(nil)).Elem()
}
func (o OAuthTokenPtrOutput) ToOAuthTokenPtrOutput() OAuthTokenPtrOutput {
return o
}
func (o OAuthTokenPtrOutput) ToOAuthTokenPtrOutputWithContext(ctx context.Context) OAuthTokenPtrOutput {
return o
}
func (o OAuthTokenPtrOutput) Elem() OAuthTokenOutput {
return o.ApplyT(func(v *OAuthToken) OAuthToken {
if v != nil {
return *v
}
var ret OAuthToken
return ret
}).(OAuthTokenOutput)
}
// OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
func (o OAuthTokenPtrOutput) Scope() pulumi.StringPtrOutput {
return o.ApplyT(func(v *OAuthToken) *string {
if v == nil {
return nil
}
return v.Scope
}).(pulumi.StringPtrOutput)
}
// [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.
func (o OAuthTokenPtrOutput) ServiceAccountEmail() pulumi.StringPtrOutput {
return o.ApplyT(func(v *OAuthToken) *string {
if v == nil {
return nil
}
return v.ServiceAccountEmail
}).(pulumi.StringPtrOutput)
}
// 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 OAuthTokenResponse struct {
// 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 `pulumi:"scope"`
// [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 `pulumi:"serviceAccountEmail"`
}
// 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 OAuthTokenResponseOutput struct{ *pulumi.OutputState }
func (OAuthTokenResponseOutput) ElementType() reflect.Type {
return reflect.TypeOf((*OAuthTokenResponse)(nil)).Elem()
}
func (o OAuthTokenResponseOutput) ToOAuthTokenResponseOutput() OAuthTokenResponseOutput {
return o
}
func (o OAuthTokenResponseOutput) ToOAuthTokenResponseOutputWithContext(ctx context.Context) OAuthTokenResponseOutput {
return o
}
// OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
func (o OAuthTokenResponseOutput) Scope() pulumi.StringOutput {
return o.ApplyT(func(v OAuthTokenResponse) string { return v.Scope }).(pulumi.StringOutput)
}
// [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.
func (o OAuthTokenResponseOutput) ServiceAccountEmail() pulumi.StringOutput {
return o.ApplyT(func(v OAuthTokenResponse) string { return v.ServiceAccountEmail }).(pulumi.StringOutput)
}
// 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 {