/
target.pb.go
executable file
·2016 lines (1837 loc) · 80.4 KB
/
target.pb.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 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.32.0
// protoc v4.25.2
// source: google/cloud/tasks/v2beta3/target.proto
package cloudtaskspb
import (
reflect "reflect"
sync "sync"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// The HTTP method used to execute the task.
type HttpMethod int32
const (
// HTTP method unspecified
HttpMethod_HTTP_METHOD_UNSPECIFIED HttpMethod = 0
// HTTP POST
HttpMethod_POST HttpMethod = 1
// HTTP GET
HttpMethod_GET HttpMethod = 2
// HTTP HEAD
HttpMethod_HEAD HttpMethod = 3
// HTTP PUT
HttpMethod_PUT HttpMethod = 4
// HTTP DELETE
HttpMethod_DELETE HttpMethod = 5
// HTTP PATCH
HttpMethod_PATCH HttpMethod = 6
// HTTP OPTIONS
HttpMethod_OPTIONS HttpMethod = 7
)
// Enum value maps for HttpMethod.
var (
HttpMethod_name = map[int32]string{
0: "HTTP_METHOD_UNSPECIFIED",
1: "POST",
2: "GET",
3: "HEAD",
4: "PUT",
5: "DELETE",
6: "PATCH",
7: "OPTIONS",
}
HttpMethod_value = map[string]int32{
"HTTP_METHOD_UNSPECIFIED": 0,
"POST": 1,
"GET": 2,
"HEAD": 3,
"PUT": 4,
"DELETE": 5,
"PATCH": 6,
"OPTIONS": 7,
}
)
func (x HttpMethod) Enum() *HttpMethod {
p := new(HttpMethod)
*p = x
return p
}
func (x HttpMethod) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (HttpMethod) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_tasks_v2beta3_target_proto_enumTypes[0].Descriptor()
}
func (HttpMethod) Type() protoreflect.EnumType {
return &file_google_cloud_tasks_v2beta3_target_proto_enumTypes[0]
}
func (x HttpMethod) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use HttpMethod.Descriptor instead.
func (HttpMethod) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{0}
}
// The Scheme for an HTTP request. By default, it is HTTPS.
type UriOverride_Scheme int32
const (
// Scheme unspecified. Defaults to HTTPS.
UriOverride_SCHEME_UNSPECIFIED UriOverride_Scheme = 0
// Convert the scheme to HTTP, e.g., https://www.google.ca will change to
// http://www.google.ca.
UriOverride_HTTP UriOverride_Scheme = 1
// Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
// https://www.google.ca.
UriOverride_HTTPS UriOverride_Scheme = 2
)
// Enum value maps for UriOverride_Scheme.
var (
UriOverride_Scheme_name = map[int32]string{
0: "SCHEME_UNSPECIFIED",
1: "HTTP",
2: "HTTPS",
}
UriOverride_Scheme_value = map[string]int32{
"SCHEME_UNSPECIFIED": 0,
"HTTP": 1,
"HTTPS": 2,
}
)
func (x UriOverride_Scheme) Enum() *UriOverride_Scheme {
p := new(UriOverride_Scheme)
*p = x
return p
}
func (x UriOverride_Scheme) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (UriOverride_Scheme) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_tasks_v2beta3_target_proto_enumTypes[1].Descriptor()
}
func (UriOverride_Scheme) Type() protoreflect.EnumType {
return &file_google_cloud_tasks_v2beta3_target_proto_enumTypes[1]
}
func (x UriOverride_Scheme) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use UriOverride_Scheme.Descriptor instead.
func (UriOverride_Scheme) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{3, 0}
}
// UriOverrideEnforceMode mode is to define enforcing mode for the override
// modes.
type UriOverride_UriOverrideEnforceMode int32
const (
// OverrideMode Unspecified. Defaults to ALWAYS.
UriOverride_URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED UriOverride_UriOverrideEnforceMode = 0
// In the IF_NOT_EXISTS mode, queue-level configuration is only
// applied where task-level configuration does not exist.
UriOverride_IF_NOT_EXISTS UriOverride_UriOverrideEnforceMode = 1
// In the ALWAYS mode, queue-level configuration overrides all
// task-level configuration
UriOverride_ALWAYS UriOverride_UriOverrideEnforceMode = 2
)
// Enum value maps for UriOverride_UriOverrideEnforceMode.
var (
UriOverride_UriOverrideEnforceMode_name = map[int32]string{
0: "URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED",
1: "IF_NOT_EXISTS",
2: "ALWAYS",
}
UriOverride_UriOverrideEnforceMode_value = map[string]int32{
"URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED": 0,
"IF_NOT_EXISTS": 1,
"ALWAYS": 2,
}
)
func (x UriOverride_UriOverrideEnforceMode) Enum() *UriOverride_UriOverrideEnforceMode {
p := new(UriOverride_UriOverrideEnforceMode)
*p = x
return p
}
func (x UriOverride_UriOverrideEnforceMode) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (UriOverride_UriOverrideEnforceMode) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_tasks_v2beta3_target_proto_enumTypes[2].Descriptor()
}
func (UriOverride_UriOverrideEnforceMode) Type() protoreflect.EnumType {
return &file_google_cloud_tasks_v2beta3_target_proto_enumTypes[2]
}
func (x UriOverride_UriOverrideEnforceMode) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use UriOverride_UriOverrideEnforceMode.Descriptor instead.
func (UriOverride_UriOverrideEnforceMode) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{3, 1}
}
// Pull Message.
//
// This proto can only be used for tasks in a queue which has
// [PULL][google.cloud.tasks.v2beta3.Queue.type] type. It currently exists for
// backwards compatibility with the App Engine Task Queue SDK. This message type
// maybe returned with methods
// [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and
// [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view
// is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].
type PullMessage struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// A data payload consumed by the worker to execute the task.
Payload []byte `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
// The tasks's tag.
//
// The tag is less than 500 characters.
//
// SDK compatibility: Although the SDK allows tags to be either
// string or
// [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
// only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
// encoded, the tag will be empty when the task is returned by Cloud Tasks.
Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
}
func (x *PullMessage) Reset() {
*x = PullMessage{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *PullMessage) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*PullMessage) ProtoMessage() {}
func (x *PullMessage) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use PullMessage.ProtoReflect.Descriptor instead.
func (*PullMessage) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{0}
}
func (x *PullMessage) GetPayload() []byte {
if x != nil {
return x.Payload
}
return nil
}
func (x *PullMessage) GetTag() string {
if x != nil {
return x.Tag
}
return ""
}
// PathOverride.
//
// Path message defines path override for HTTP targets.
type PathOverride struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The URI path (e.g., /users/1234). Default is an empty string.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
}
func (x *PathOverride) Reset() {
*x = PathOverride{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *PathOverride) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*PathOverride) ProtoMessage() {}
func (x *PathOverride) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use PathOverride.ProtoReflect.Descriptor instead.
func (*PathOverride) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{1}
}
func (x *PathOverride) GetPath() string {
if x != nil {
return x.Path
}
return ""
}
// QueryOverride.
//
// Query message defines query override for HTTP targets.
type QueryOverride struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty
// string.
QueryParams string `protobuf:"bytes,1,opt,name=query_params,json=queryParams,proto3" json:"query_params,omitempty"`
}
func (x *QueryOverride) Reset() {
*x = QueryOverride{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *QueryOverride) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*QueryOverride) ProtoMessage() {}
func (x *QueryOverride) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use QueryOverride.ProtoReflect.Descriptor instead.
func (*QueryOverride) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{2}
}
func (x *QueryOverride) GetQueryParams() string {
if x != nil {
return x.QueryParams
}
return ""
}
// URI Override.
//
// When specified, all the HTTP tasks inside the queue will be partially or
// fully overridden depending on the configured values.
type UriOverride struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Scheme override.
//
// When specified, the task URI scheme is replaced by the provided value (HTTP
// or HTTPS).
Scheme *UriOverride_Scheme `protobuf:"varint,1,opt,name=scheme,proto3,enum=google.cloud.tasks.v2beta3.UriOverride_Scheme,oneof" json:"scheme,omitempty"`
// Host override.
//
// When specified, replaces the host part of the task URL. For example,
// if the task URL is "https://www.google.com," and host value is set to
// "example.net", the overridden URI will be changed to "https://example.net."
// Host value cannot be an empty string (INVALID_ARGUMENT).
Host *string `protobuf:"bytes,2,opt,name=host,proto3,oneof" json:"host,omitempty"`
// Port override.
//
// When specified, replaces the port part of the task URI. For instance,
// for a URI http://www.google.com/foo and port=123, the overridden URI
// becomes http://www.google.com:123/foo. Note that the port value must be a
// positive integer. Setting the port to 0 (Zero) clears the URI port.
Port *int64 `protobuf:"varint,3,opt,name=port,proto3,oneof" json:"port,omitempty"`
// URI path.
//
// When specified, replaces the existing path of the task URL. Setting the
// path value to an empty string clears the URI path segment.
PathOverride *PathOverride `protobuf:"bytes,4,opt,name=path_override,json=pathOverride,proto3" json:"path_override,omitempty"`
// URI Query.
//
// When specified, replaces the query part of the task URI. Setting the
// query value to an empty string clears the URI query segment.
QueryOverride *QueryOverride `protobuf:"bytes,5,opt,name=query_override,json=queryOverride,proto3" json:"query_override,omitempty"`
// URI Override Enforce Mode
//
// When specified, determines the Target UriOverride mode. If not specified,
// it defaults to ALWAYS.
UriOverrideEnforceMode UriOverride_UriOverrideEnforceMode `protobuf:"varint,6,opt,name=uri_override_enforce_mode,json=uriOverrideEnforceMode,proto3,enum=google.cloud.tasks.v2beta3.UriOverride_UriOverrideEnforceMode" json:"uri_override_enforce_mode,omitempty"`
}
func (x *UriOverride) Reset() {
*x = UriOverride{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *UriOverride) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*UriOverride) ProtoMessage() {}
func (x *UriOverride) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use UriOverride.ProtoReflect.Descriptor instead.
func (*UriOverride) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{3}
}
func (x *UriOverride) GetScheme() UriOverride_Scheme {
if x != nil && x.Scheme != nil {
return *x.Scheme
}
return UriOverride_SCHEME_UNSPECIFIED
}
func (x *UriOverride) GetHost() string {
if x != nil && x.Host != nil {
return *x.Host
}
return ""
}
func (x *UriOverride) GetPort() int64 {
if x != nil && x.Port != nil {
return *x.Port
}
return 0
}
func (x *UriOverride) GetPathOverride() *PathOverride {
if x != nil {
return x.PathOverride
}
return nil
}
func (x *UriOverride) GetQueryOverride() *QueryOverride {
if x != nil {
return x.QueryOverride
}
return nil
}
func (x *UriOverride) GetUriOverrideEnforceMode() UriOverride_UriOverrideEnforceMode {
if x != nil {
return x.UriOverrideEnforceMode
}
return UriOverride_URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED
}
// HTTP target.
//
// When specified as a [Queue][target_type], all the tasks with [HttpRequest]
// will be overridden according to the target.
type HttpTarget struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// URI override.
//
// When specified, overrides the execution URI for all the tasks in the queue.
UriOverride *UriOverride `protobuf:"bytes,1,opt,name=uri_override,json=uriOverride,proto3" json:"uri_override,omitempty"`
// The HTTP method to use for the request.
//
// When specified, it overrides
// [HttpRequest][google.cloud.tasks.v2beta3.HttpTarget.http_method] for the
// task. Note that if the value is set to [HttpMethod][GET] the
// [HttpRequest][body] of the task will be ignored at execution time.
HttpMethod HttpMethod `protobuf:"varint,2,opt,name=http_method,json=httpMethod,proto3,enum=google.cloud.tasks.v2beta3.HttpMethod" json:"http_method,omitempty"`
// HTTP target headers.
//
// This map contains the header field names and values.
// Headers will be set when running the
// [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] and/or
// [BufferTask][google.cloud.tasks.v2beta3.CloudTasks.BufferTask].
//
// These headers represent a subset of the headers that will be configured for
// the task's HTTP request. Some HTTP request headers will be ignored or
// replaced.
//
// A partial list of headers that will be ignored or replaced is:
// * Several predefined headers, prefixed with "X-CloudTasks-", can
// be used to define properties of the task.
// * Host: This will be computed by Cloud Tasks and derived from
// [HttpRequest.url][google.cloud.tasks.v2beta3.Target.HttpRequest.url].
// * Content-Length: This will be computed by Cloud Tasks.
//
// `Content-Type` won't be set by Cloud Tasks. You can explicitly set
// `Content-Type` to a media type when the
//
// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
// For example,`Content-Type` can be set to `"application/octet-stream"` or
// `"application/json"`. The default value is set to `"application/json"`.
//
// * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
//
// Headers which can have multiple values (according to RFC2616) can be
// specified using comma-separated values.
//
// The size of the headers must be less than 80KB.
// Queue-level headers to override headers of all the tasks in the queue.
HeaderOverrides []*HttpTarget_HeaderOverride `protobuf:"bytes,3,rep,name=header_overrides,json=headerOverrides,proto3" json:"header_overrides,omitempty"`
// The mode for generating an `Authorization` header for HTTP requests.
//
// If specified, all `Authorization` headers in the
// [HttpRequest.headers][google.cloud.tasks.v2beta3.HttpRequest.headers] field
// will be overridden.
//
// Types that are assignable to AuthorizationHeader:
//
// *HttpTarget_OauthToken
// *HttpTarget_OidcToken
AuthorizationHeader isHttpTarget_AuthorizationHeader `protobuf_oneof:"authorization_header"`
}
func (x *HttpTarget) Reset() {
*x = HttpTarget{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *HttpTarget) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*HttpTarget) ProtoMessage() {}
func (x *HttpTarget) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[4]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use HttpTarget.ProtoReflect.Descriptor instead.
func (*HttpTarget) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{4}
}
func (x *HttpTarget) GetUriOverride() *UriOverride {
if x != nil {
return x.UriOverride
}
return nil
}
func (x *HttpTarget) GetHttpMethod() HttpMethod {
if x != nil {
return x.HttpMethod
}
return HttpMethod_HTTP_METHOD_UNSPECIFIED
}
func (x *HttpTarget) GetHeaderOverrides() []*HttpTarget_HeaderOverride {
if x != nil {
return x.HeaderOverrides
}
return nil
}
func (m *HttpTarget) GetAuthorizationHeader() isHttpTarget_AuthorizationHeader {
if m != nil {
return m.AuthorizationHeader
}
return nil
}
func (x *HttpTarget) GetOauthToken() *OAuthToken {
if x, ok := x.GetAuthorizationHeader().(*HttpTarget_OauthToken); ok {
return x.OauthToken
}
return nil
}
func (x *HttpTarget) GetOidcToken() *OidcToken {
if x, ok := x.GetAuthorizationHeader().(*HttpTarget_OidcToken); ok {
return x.OidcToken
}
return nil
}
type isHttpTarget_AuthorizationHeader interface {
isHttpTarget_AuthorizationHeader()
}
type HttpTarget_OauthToken struct {
// If specified, an
// [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
// will be generated and attached as the `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 `protobuf:"bytes,5,opt,name=oauth_token,json=oauthToken,proto3,oneof"`
}
type HttpTarget_OidcToken struct {
// 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 `protobuf:"bytes,6,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}
func (*HttpTarget_OauthToken) isHttpTarget_AuthorizationHeader() {}
func (*HttpTarget_OidcToken) isHttpTarget_AuthorizationHeader() {}
// HTTP request.
//
// The task will be pushed to the worker as an HTTP request. If the worker
// or the redirected worker acknowledges the task by returning a successful HTTP
// response code ([`200` - `299`]), the task will be removed from the queue. If
// any other HTTP response code is returned or no response is received, the
// task will be retried according to the following:
//
// * User-specified throttling: [retry
// configuration][google.cloud.tasks.v2beta3.Queue.retry_config],
//
// [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits], and the
// [queue's state][google.cloud.tasks.v2beta3.Queue.state].
//
// - System throttling: To prevent the worker from overloading, Cloud Tasks may
// temporarily reduce the queue's effective rate. User-specified settings
// will not be changed.
//
// System throttling happens because:
//
// - Cloud Tasks backs off on all errors. Normally the backoff specified in
// [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits] will be used.
// But if the worker returns `429` (Too Many Requests), `503` (Service
// Unavailable), or the rate of errors is high, Cloud Tasks will use a
// higher backoff rate. The retry specified in the `Retry-After` HTTP
// response header is considered.
//
// - To prevent traffic spikes and to smooth sudden increases in traffic,
// dispatches ramp up slowly when the queue is newly created or idle and
// if large numbers of tasks suddenly become available to dispatch (due to
// spikes in create task rates, the queue being unpaused, or many tasks
// that are scheduled at the same time).
type HttpRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. The full url path that the request will be sent to.
//
// This string must begin with either "http://" or "https://". Some examples
// are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
// encode some characters for safety and compatibility. The maximum allowed
// URL length is 2083 characters after encoding.
//
// The `Location` header response from a redirect response [`300` - `399`]
// may be followed. The redirect is not counted as a separate attempt.
Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
// The HTTP method to use for the request. The default is POST.
HttpMethod HttpMethod `protobuf:"varint,2,opt,name=http_method,json=httpMethod,proto3,enum=google.cloud.tasks.v2beta3.HttpMethod" json:"http_method,omitempty"`
// HTTP request headers.
//
// This map contains the header field names and values.
// Headers can be set when the
// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
//
// These headers represent a subset of the headers that will accompany the
// task's HTTP request. Some HTTP request headers will be ignored or replaced.
//
// A partial list of headers that will be ignored or replaced is:
//
// * Any header that is prefixed with "X-CloudTasks-" will be treated
// as service header. Service headers define properties of the task and are
// predefined in CloudTask.
// - Host: This will be computed by Cloud Tasks and derived from
// [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url].
// - Content-Length: This will be computed by Cloud Tasks.
// - User-Agent: This will be set to `"Google-Cloud-Tasks"`.
// - `X-Google-*`: Google use only.
// - `X-AppEngine-*`: Google use only.
//
// `Content-Type` won't be set by Cloud Tasks. You can explicitly set
// `Content-Type` to a media type when the
//
// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
// For example, `Content-Type` can be set to `"application/octet-stream"` or
// `"application/json"`.
//
// Headers which can have multiple values (according to RFC2616) can be
// specified using comma-separated values.
//
// The size of the headers must be less than 80KB.
Headers map[string]string `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// HTTP request body.
//
// A request body is allowed only if the
// [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST,
// PUT, or PATCH. It is an error to set body on a task with an incompatible
// [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
Body []byte `protobuf:"bytes,4,opt,name=body,proto3" json:"body,omitempty"`
// The mode for generating an `Authorization` header for HTTP requests.
//
// If specified, all `Authorization` headers in the
// [HttpRequest.headers][google.cloud.tasks.v2beta3.HttpRequest.headers] field
// will be overridden.
//
// Types that are assignable to AuthorizationHeader:
//
// *HttpRequest_OauthToken
// *HttpRequest_OidcToken
AuthorizationHeader isHttpRequest_AuthorizationHeader `protobuf_oneof:"authorization_header"`
}
func (x *HttpRequest) Reset() {
*x = HttpRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *HttpRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*HttpRequest) ProtoMessage() {}
func (x *HttpRequest) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[5]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use HttpRequest.ProtoReflect.Descriptor instead.
func (*HttpRequest) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{5}
}
func (x *HttpRequest) GetUrl() string {
if x != nil {
return x.Url
}
return ""
}
func (x *HttpRequest) GetHttpMethod() HttpMethod {
if x != nil {
return x.HttpMethod
}
return HttpMethod_HTTP_METHOD_UNSPECIFIED
}
func (x *HttpRequest) GetHeaders() map[string]string {
if x != nil {
return x.Headers
}
return nil
}
func (x *HttpRequest) GetBody() []byte {
if x != nil {
return x.Body
}
return nil
}
func (m *HttpRequest) GetAuthorizationHeader() isHttpRequest_AuthorizationHeader {
if m != nil {
return m.AuthorizationHeader
}
return nil
}
func (x *HttpRequest) GetOauthToken() *OAuthToken {
if x, ok := x.GetAuthorizationHeader().(*HttpRequest_OauthToken); ok {
return x.OauthToken
}
return nil
}
func (x *HttpRequest) GetOidcToken() *OidcToken {
if x, ok := x.GetAuthorizationHeader().(*HttpRequest_OidcToken); ok {
return x.OidcToken
}
return nil
}
type isHttpRequest_AuthorizationHeader interface {
isHttpRequest_AuthorizationHeader()
}
type HttpRequest_OauthToken struct {
// 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 `protobuf:"bytes,5,opt,name=oauth_token,json=oauthToken,proto3,oneof"`
}
type HttpRequest_OidcToken struct {
// 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 `protobuf:"bytes,6,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}
func (*HttpRequest_OauthToken) isHttpRequest_AuthorizationHeader() {}
func (*HttpRequest_OidcToken) isHttpRequest_AuthorizationHeader() {}
// App Engine HTTP queue.
//
// The task will be delivered to the App Engine application hostname
// specified by its
// [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and
// [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]. The
// documentation for
// [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]
// explains how the task's host URL is constructed.
//
// Using [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue]
// requires
// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
// Google IAM permission for the project
// and the following scope:
//
// `https://www.googleapis.com/auth/cloud-platform`
type AppEngineHttpQueue struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Overrides for the
// [task-level
// app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
//
// If set, `app_engine_routing_override` is used for all tasks in
// the queue, no matter what the setting is for the
// [task-level
// app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
AppEngineRoutingOverride *AppEngineRouting `protobuf:"bytes,1,opt,name=app_engine_routing_override,json=appEngineRoutingOverride,proto3" json:"app_engine_routing_override,omitempty"`
}
func (x *AppEngineHttpQueue) Reset() {
*x = AppEngineHttpQueue{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *AppEngineHttpQueue) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*AppEngineHttpQueue) ProtoMessage() {}
func (x *AppEngineHttpQueue) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_tasks_v2beta3_target_proto_msgTypes[6]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use AppEngineHttpQueue.ProtoReflect.Descriptor instead.
func (*AppEngineHttpQueue) Descriptor() ([]byte, []int) {
return file_google_cloud_tasks_v2beta3_target_proto_rawDescGZIP(), []int{6}
}
func (x *AppEngineHttpQueue) GetAppEngineRoutingOverride() *AppEngineRouting {
if x != nil {
return x.AppEngineRoutingOverride
}
return nil
}
// App Engine HTTP request.
//
// The message defines the HTTP request that is sent to an App Engine app when
// the task is dispatched.
//
// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]
// requires
// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
// Google IAM permission for the project
// and the following scope:
//
// `https://www.googleapis.com/auth/cloud-platform`
//
// The task will be delivered to the App Engine app which belongs to the same
// project as the queue. For more information, see
// [How Requests are
// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
// and how routing is affected by
// [dispatch
// files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
// Traffic is encrypted during transport and never leaves Google datacenters.
// Because this traffic is carried over a communication mechanism internal to
// Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
// The request to the handler, however, will appear to have used the HTTP
// protocol.
//