This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
AppEngineHttpRequest.java
2076 lines (1972 loc) · 81.7 KB
/
AppEngineHttpRequest.java
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 2020 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
*
* https://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.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/tasks/v2/target.proto
package com.google.cloud.tasks.v2;
/**
*
*
* <pre>
* 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.v2.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.
* The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] used to construct the URL that the task is
* delivered to can be set at the queue-level or task-level:
* * If [app_engine_routing_override is set on the
* queue][Queue.app_engine_routing_override], this value is used for all
* tasks in the queue, no matter what the setting is for the [task-level
* app_engine_routing][AppEngineHttpRequest.app_engine_routing].
* The `url` that the task will be sent to is:
* * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
* [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri]
* Tasks can be dispatched to secure app handlers, unsecure app handlers, and
* URIs restricted with
* [`login:
* admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
* Because tasks are not run as any user, they cannot be dispatched to URIs
* restricted with
* [`login:
* required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
* Task dispatches also do not follow redirects.
* The task attempt has succeeded if the app's request handler returns an HTTP
* response code in the range [`200` - `299`]. The task attempt has failed if
* the app's handler returns a non-2xx response code or Cloud Tasks does
* not receive response before the [deadline][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed
* tasks will be retried according to the
* [retry configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service Unavailable) is
* considered an App Engine system error instead of an application error and
* will cause Cloud Tasks' traffic congestion control to temporarily throttle
* the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
* Requests) response from an app handler does not cause traffic congestion
* control to throttle the queue.
* </pre>
*
* Protobuf type {@code google.cloud.tasks.v2.AppEngineHttpRequest}
*/
public final class AppEngineHttpRequest extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.cloud.tasks.v2.AppEngineHttpRequest)
AppEngineHttpRequestOrBuilder {
private static final long serialVersionUID = 0L;
// Use AppEngineHttpRequest.newBuilder() to construct.
private AppEngineHttpRequest(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private AppEngineHttpRequest() {
httpMethod_ = 0;
relativeUri_ = "";
body_ = com.google.protobuf.ByteString.EMPTY;
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
return new AppEngineHttpRequest();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
return this.unknownFields;
}
private AppEngineHttpRequest(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 8:
{
int rawValue = input.readEnum();
httpMethod_ = rawValue;
break;
}
case 18:
{
com.google.cloud.tasks.v2.AppEngineRouting.Builder subBuilder = null;
if (appEngineRouting_ != null) {
subBuilder = appEngineRouting_.toBuilder();
}
appEngineRouting_ =
input.readMessage(
com.google.cloud.tasks.v2.AppEngineRouting.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(appEngineRouting_);
appEngineRouting_ = subBuilder.buildPartial();
}
break;
}
case 26:
{
java.lang.String s = input.readStringRequireUtf8();
relativeUri_ = s;
break;
}
case 34:
{
if (!((mutable_bitField0_ & 0x00000001) != 0)) {
headers_ =
com.google.protobuf.MapField.newMapField(
HeadersDefaultEntryHolder.defaultEntry);
mutable_bitField0_ |= 0x00000001;
}
com.google.protobuf.MapEntry<java.lang.String, java.lang.String> headers__ =
input.readMessage(
HeadersDefaultEntryHolder.defaultEntry.getParserForType(), extensionRegistry);
headers_.getMutableMap().put(headers__.getKey(), headers__.getValue());
break;
}
case 42:
{
body_ = input.readBytes();
break;
}
default:
{
if (!parseUnknownField(input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.cloud.tasks.v2.TargetProto
.internal_static_google_cloud_tasks_v2_AppEngineHttpRequest_descriptor;
}
@SuppressWarnings({"rawtypes"})
@java.lang.Override
protected com.google.protobuf.MapField internalGetMapField(int number) {
switch (number) {
case 4:
return internalGetHeaders();
default:
throw new RuntimeException("Invalid map field number: " + number);
}
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.cloud.tasks.v2.TargetProto
.internal_static_google_cloud_tasks_v2_AppEngineHttpRequest_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.cloud.tasks.v2.AppEngineHttpRequest.class,
com.google.cloud.tasks.v2.AppEngineHttpRequest.Builder.class);
}
public static final int HTTP_METHOD_FIELD_NUMBER = 1;
private int httpMethod_;
/**
*
*
* <pre>
* The HTTP method to use for the request. The default is POST.
* The app's request handler for the task's target URL must be able to handle
* HTTP requests with this http_method, otherwise the task attempt will fail
* with error code 405 (Method Not Allowed). See
* [Writing a push task request
* handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
* and the documentation for the request handlers in the language your app is
* written in e.g.
* [Python Request
* Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
* </pre>
*
* <code>.google.cloud.tasks.v2.HttpMethod http_method = 1;</code>
*
* @return The enum numeric value on the wire for httpMethod.
*/
@java.lang.Override
public int getHttpMethodValue() {
return httpMethod_;
}
/**
*
*
* <pre>
* The HTTP method to use for the request. The default is POST.
* The app's request handler for the task's target URL must be able to handle
* HTTP requests with this http_method, otherwise the task attempt will fail
* with error code 405 (Method Not Allowed). See
* [Writing a push task request
* handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
* and the documentation for the request handlers in the language your app is
* written in e.g.
* [Python Request
* Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
* </pre>
*
* <code>.google.cloud.tasks.v2.HttpMethod http_method = 1;</code>
*
* @return The httpMethod.
*/
@java.lang.Override
public com.google.cloud.tasks.v2.HttpMethod getHttpMethod() {
@SuppressWarnings("deprecation")
com.google.cloud.tasks.v2.HttpMethod result =
com.google.cloud.tasks.v2.HttpMethod.valueOf(httpMethod_);
return result == null ? com.google.cloud.tasks.v2.HttpMethod.UNRECOGNIZED : result;
}
public static final int APP_ENGINE_ROUTING_FIELD_NUMBER = 2;
private com.google.cloud.tasks.v2.AppEngineRouting appEngineRouting_;
/**
*
*
* <pre>
* Task-level setting for App Engine routing.
* * If [app_engine_routing_override is set on the
* queue][Queue.app_engine_routing_override], this value is used for all
* tasks in the queue, no matter what the setting is for the [task-level
* app_engine_routing][AppEngineHttpRequest.app_engine_routing].
* </pre>
*
* <code>.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;</code>
*
* @return Whether the appEngineRouting field is set.
*/
@java.lang.Override
public boolean hasAppEngineRouting() {
return appEngineRouting_ != null;
}
/**
*
*
* <pre>
* Task-level setting for App Engine routing.
* * If [app_engine_routing_override is set on the
* queue][Queue.app_engine_routing_override], this value is used for all
* tasks in the queue, no matter what the setting is for the [task-level
* app_engine_routing][AppEngineHttpRequest.app_engine_routing].
* </pre>
*
* <code>.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;</code>
*
* @return The appEngineRouting.
*/
@java.lang.Override
public com.google.cloud.tasks.v2.AppEngineRouting getAppEngineRouting() {
return appEngineRouting_ == null
? com.google.cloud.tasks.v2.AppEngineRouting.getDefaultInstance()
: appEngineRouting_;
}
/**
*
*
* <pre>
* Task-level setting for App Engine routing.
* * If [app_engine_routing_override is set on the
* queue][Queue.app_engine_routing_override], this value is used for all
* tasks in the queue, no matter what the setting is for the [task-level
* app_engine_routing][AppEngineHttpRequest.app_engine_routing].
* </pre>
*
* <code>.google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2;</code>
*/
@java.lang.Override
public com.google.cloud.tasks.v2.AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder() {
return getAppEngineRouting();
}
public static final int RELATIVE_URI_FIELD_NUMBER = 3;
private volatile java.lang.Object relativeUri_;
/**
*
*
* <pre>
* The relative URI.
* The relative URI must begin with "/" and must be a valid HTTP relative URI.
* It can contain a path and query string arguments.
* If the relative URI is empty, then the root path "/" will be used.
* No spaces are allowed, and the maximum length allowed is 2083 characters.
* </pre>
*
* <code>string relative_uri = 3;</code>
*
* @return The relativeUri.
*/
@java.lang.Override
public java.lang.String getRelativeUri() {
java.lang.Object ref = relativeUri_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
relativeUri_ = s;
return s;
}
}
/**
*
*
* <pre>
* The relative URI.
* The relative URI must begin with "/" and must be a valid HTTP relative URI.
* It can contain a path and query string arguments.
* If the relative URI is empty, then the root path "/" will be used.
* No spaces are allowed, and the maximum length allowed is 2083 characters.
* </pre>
*
* <code>string relative_uri = 3;</code>
*
* @return The bytes for relativeUri.
*/
@java.lang.Override
public com.google.protobuf.ByteString getRelativeUriBytes() {
java.lang.Object ref = relativeUri_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
relativeUri_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int HEADERS_FIELD_NUMBER = 4;
private static final class HeadersDefaultEntryHolder {
static final com.google.protobuf.MapEntry<java.lang.String, java.lang.String> defaultEntry =
com.google.protobuf.MapEntry.<java.lang.String, java.lang.String>newDefaultInstance(
com.google.cloud.tasks.v2.TargetProto
.internal_static_google_cloud_tasks_v2_AppEngineHttpRequest_HeadersEntry_descriptor,
com.google.protobuf.WireFormat.FieldType.STRING,
"",
com.google.protobuf.WireFormat.FieldType.STRING,
"");
}
private com.google.protobuf.MapField<java.lang.String, java.lang.String> headers_;
private com.google.protobuf.MapField<java.lang.String, java.lang.String> internalGetHeaders() {
if (headers_ == null) {
return com.google.protobuf.MapField.emptyMapField(HeadersDefaultEntryHolder.defaultEntry);
}
return headers_;
}
public int getHeadersCount() {
return internalGetHeaders().getMap().size();
}
/**
*
*
* <pre>
* HTTP request headers.
* This map contains the header field names and values.
* Headers can be set when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* Repeated headers are not supported but a header value can contain commas.
* Cloud Tasks 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 Tasks will append
* `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
* modified `User-Agent`.
* If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
* Tasks sets the following headers:
* * `Content-Type`: By default, the `Content-Type` header is set to
* `"application/octet-stream"`. The default can be overridden by explicitly
* setting `Content-Type` to a particular media type when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* For example, `Content-Type` can be set to `"application/json"`.
* * `Content-Length`: This is computed by Cloud Tasks. This value is
* output only. It cannot be changed.
* The headers below cannot be set or overridden:
* * `Host`
* * `X-Google-*`
* * `X-AppEngine-*`
* In addition, Cloud Tasks sets some headers when the task is dispatched,
* such as headers containing information about the task; see
* [request
* headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
* These headers are set only when the task is dispatched, so they are not
* visible when the task is returned in a Cloud Tasks response.
* Although there is no specific limit for the maximum number of headers or
* the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
* information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
* </pre>
*
* <code>map<string, string> headers = 4;</code>
*/
@java.lang.Override
public boolean containsHeaders(java.lang.String key) {
if (key == null) {
throw new java.lang.NullPointerException();
}
return internalGetHeaders().getMap().containsKey(key);
}
/** Use {@link #getHeadersMap()} instead. */
@java.lang.Override
@java.lang.Deprecated
public java.util.Map<java.lang.String, java.lang.String> getHeaders() {
return getHeadersMap();
}
/**
*
*
* <pre>
* HTTP request headers.
* This map contains the header field names and values.
* Headers can be set when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* Repeated headers are not supported but a header value can contain commas.
* Cloud Tasks 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 Tasks will append
* `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
* modified `User-Agent`.
* If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
* Tasks sets the following headers:
* * `Content-Type`: By default, the `Content-Type` header is set to
* `"application/octet-stream"`. The default can be overridden by explicitly
* setting `Content-Type` to a particular media type when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* For example, `Content-Type` can be set to `"application/json"`.
* * `Content-Length`: This is computed by Cloud Tasks. This value is
* output only. It cannot be changed.
* The headers below cannot be set or overridden:
* * `Host`
* * `X-Google-*`
* * `X-AppEngine-*`
* In addition, Cloud Tasks sets some headers when the task is dispatched,
* such as headers containing information about the task; see
* [request
* headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
* These headers are set only when the task is dispatched, so they are not
* visible when the task is returned in a Cloud Tasks response.
* Although there is no specific limit for the maximum number of headers or
* the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
* information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
* </pre>
*
* <code>map<string, string> headers = 4;</code>
*/
@java.lang.Override
public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
return internalGetHeaders().getMap();
}
/**
*
*
* <pre>
* HTTP request headers.
* This map contains the header field names and values.
* Headers can be set when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* Repeated headers are not supported but a header value can contain commas.
* Cloud Tasks 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 Tasks will append
* `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
* modified `User-Agent`.
* If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
* Tasks sets the following headers:
* * `Content-Type`: By default, the `Content-Type` header is set to
* `"application/octet-stream"`. The default can be overridden by explicitly
* setting `Content-Type` to a particular media type when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* For example, `Content-Type` can be set to `"application/json"`.
* * `Content-Length`: This is computed by Cloud Tasks. This value is
* output only. It cannot be changed.
* The headers below cannot be set or overridden:
* * `Host`
* * `X-Google-*`
* * `X-AppEngine-*`
* In addition, Cloud Tasks sets some headers when the task is dispatched,
* such as headers containing information about the task; see
* [request
* headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
* These headers are set only when the task is dispatched, so they are not
* visible when the task is returned in a Cloud Tasks response.
* Although there is no specific limit for the maximum number of headers or
* the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
* information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
* </pre>
*
* <code>map<string, string> headers = 4;</code>
*/
@java.lang.Override
public java.lang.String getHeadersOrDefault(java.lang.String key, java.lang.String defaultValue) {
if (key == null) {
throw new java.lang.NullPointerException();
}
java.util.Map<java.lang.String, java.lang.String> map = internalGetHeaders().getMap();
return map.containsKey(key) ? map.get(key) : defaultValue;
}
/**
*
*
* <pre>
* HTTP request headers.
* This map contains the header field names and values.
* Headers can be set when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* Repeated headers are not supported but a header value can contain commas.
* Cloud Tasks 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 Tasks will append
* `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
* modified `User-Agent`.
* If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
* Tasks sets the following headers:
* * `Content-Type`: By default, the `Content-Type` header is set to
* `"application/octet-stream"`. The default can be overridden by explicitly
* setting `Content-Type` to a particular media type when the
* [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
* For example, `Content-Type` can be set to `"application/json"`.
* * `Content-Length`: This is computed by Cloud Tasks. This value is
* output only. It cannot be changed.
* The headers below cannot be set or overridden:
* * `Host`
* * `X-Google-*`
* * `X-AppEngine-*`
* In addition, Cloud Tasks sets some headers when the task is dispatched,
* such as headers containing information about the task; see
* [request
* headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
* These headers are set only when the task is dispatched, so they are not
* visible when the task is returned in a Cloud Tasks response.
* Although there is no specific limit for the maximum number of headers or
* the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
* information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
* </pre>
*
* <code>map<string, string> headers = 4;</code>
*/
@java.lang.Override
public java.lang.String getHeadersOrThrow(java.lang.String key) {
if (key == null) {
throw new java.lang.NullPointerException();
}
java.util.Map<java.lang.String, java.lang.String> map = internalGetHeaders().getMap();
if (!map.containsKey(key)) {
throw new java.lang.IllegalArgumentException();
}
return map.get(key);
}
public static final int BODY_FIELD_NUMBER = 5;
private com.google.protobuf.ByteString body_;
/**
*
*
* <pre>
* HTTP request body.
* A request body is allowed only if the HTTP method is POST or PUT. It is
* an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].
* </pre>
*
* <code>bytes body = 5;</code>
*
* @return The body.
*/
@java.lang.Override
public com.google.protobuf.ByteString getBody() {
return body_;
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
if (httpMethod_ != com.google.cloud.tasks.v2.HttpMethod.HTTP_METHOD_UNSPECIFIED.getNumber()) {
output.writeEnum(1, httpMethod_);
}
if (appEngineRouting_ != null) {
output.writeMessage(2, getAppEngineRouting());
}
if (!getRelativeUriBytes().isEmpty()) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 3, relativeUri_);
}
com.google.protobuf.GeneratedMessageV3.serializeStringMapTo(
output, internalGetHeaders(), HeadersDefaultEntryHolder.defaultEntry, 4);
if (!body_.isEmpty()) {
output.writeBytes(5, body_);
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (httpMethod_ != com.google.cloud.tasks.v2.HttpMethod.HTTP_METHOD_UNSPECIFIED.getNumber()) {
size += com.google.protobuf.CodedOutputStream.computeEnumSize(1, httpMethod_);
}
if (appEngineRouting_ != null) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(2, getAppEngineRouting());
}
if (!getRelativeUriBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(3, relativeUri_);
}
for (java.util.Map.Entry<java.lang.String, java.lang.String> entry :
internalGetHeaders().getMap().entrySet()) {
com.google.protobuf.MapEntry<java.lang.String, java.lang.String> headers__ =
HeadersDefaultEntryHolder.defaultEntry
.newBuilderForType()
.setKey(entry.getKey())
.setValue(entry.getValue())
.build();
size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, headers__);
}
if (!body_.isEmpty()) {
size += com.google.protobuf.CodedOutputStream.computeBytesSize(5, body_);
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof com.google.cloud.tasks.v2.AppEngineHttpRequest)) {
return super.equals(obj);
}
com.google.cloud.tasks.v2.AppEngineHttpRequest other =
(com.google.cloud.tasks.v2.AppEngineHttpRequest) obj;
if (httpMethod_ != other.httpMethod_) return false;
if (hasAppEngineRouting() != other.hasAppEngineRouting()) return false;
if (hasAppEngineRouting()) {
if (!getAppEngineRouting().equals(other.getAppEngineRouting())) return false;
}
if (!getRelativeUri().equals(other.getRelativeUri())) return false;
if (!internalGetHeaders().equals(other.internalGetHeaders())) return false;
if (!getBody().equals(other.getBody())) return false;
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + HTTP_METHOD_FIELD_NUMBER;
hash = (53 * hash) + httpMethod_;
if (hasAppEngineRouting()) {
hash = (37 * hash) + APP_ENGINE_ROUTING_FIELD_NUMBER;
hash = (53 * hash) + getAppEngineRouting().hashCode();
}
hash = (37 * hash) + RELATIVE_URI_FIELD_NUMBER;
hash = (53 * hash) + getRelativeUri().hashCode();
if (!internalGetHeaders().getMap().isEmpty()) {
hash = (37 * hash) + HEADERS_FIELD_NUMBER;
hash = (53 * hash) + internalGetHeaders().hashCode();
}
hash = (37 * hash) + BODY_FIELD_NUMBER;
hash = (53 * hash) + getBody().hashCode();
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
PARSER, input, extensionRegistry);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseDelimitedFrom(
java.io.InputStream input) throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseDelimitedFrom(
java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(
PARSER, input, extensionRegistry);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
com.google.protobuf.CodedInputStream input) throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.cloud.tasks.v2.AppEngineHttpRequest parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() {
return newBuilder();
}
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(com.google.cloud.tasks.v2.AppEngineHttpRequest prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
*
*
* <pre>
* 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.v2.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.
* The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] used to construct the URL that the task is
* delivered to can be set at the queue-level or task-level:
* * If [app_engine_routing_override is set on the
* queue][Queue.app_engine_routing_override], this value is used for all
* tasks in the queue, no matter what the setting is for the [task-level
* app_engine_routing][AppEngineHttpRequest.app_engine_routing].
* The `url` that the task will be sent to is:
* * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
* [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri]
* Tasks can be dispatched to secure app handlers, unsecure app handlers, and
* URIs restricted with
* [`login:
* admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
* Because tasks are not run as any user, they cannot be dispatched to URIs
* restricted with
* [`login:
* required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
* Task dispatches also do not follow redirects.
* The task attempt has succeeded if the app's request handler returns an HTTP
* response code in the range [`200` - `299`]. The task attempt has failed if
* the app's handler returns a non-2xx response code or Cloud Tasks does
* not receive response before the [deadline][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed
* tasks will be retried according to the
* [retry configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service Unavailable) is
* considered an App Engine system error instead of an application error and
* will cause Cloud Tasks' traffic congestion control to temporarily throttle
* the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
* Requests) response from an app handler does not cause traffic congestion
* control to throttle the queue.
* </pre>
*
* Protobuf type {@code google.cloud.tasks.v2.AppEngineHttpRequest}
*/
public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Builder>
implements
// @@protoc_insertion_point(builder_implements:google.cloud.tasks.v2.AppEngineHttpRequest)
com.google.cloud.tasks.v2.AppEngineHttpRequestOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.cloud.tasks.v2.TargetProto
.internal_static_google_cloud_tasks_v2_AppEngineHttpRequest_descriptor;
}
@SuppressWarnings({"rawtypes"})
protected com.google.protobuf.MapField internalGetMapField(int number) {
switch (number) {
case 4:
return internalGetHeaders();
default:
throw new RuntimeException("Invalid map field number: " + number);
}
}
@SuppressWarnings({"rawtypes"})
protected com.google.protobuf.MapField internalGetMutableMapField(int number) {
switch (number) {
case 4:
return internalGetMutableHeaders();
default:
throw new RuntimeException("Invalid map field number: " + number);
}
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.cloud.tasks.v2.TargetProto
.internal_static_google_cloud_tasks_v2_AppEngineHttpRequest_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.cloud.tasks.v2.AppEngineHttpRequest.class,
com.google.cloud.tasks.v2.AppEngineHttpRequest.Builder.class);
}
// Construct using com.google.cloud.tasks.v2.AppEngineHttpRequest.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3.alwaysUseFieldBuilders) {}
}
@java.lang.Override
public Builder clear() {
super.clear();
httpMethod_ = 0;
if (appEngineRoutingBuilder_ == null) {
appEngineRouting_ = null;
} else {
appEngineRouting_ = null;
appEngineRoutingBuilder_ = null;
}
relativeUri_ = "";
internalGetMutableHeaders().clear();
body_ = com.google.protobuf.ByteString.EMPTY;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() {
return com.google.cloud.tasks.v2.TargetProto
.internal_static_google_cloud_tasks_v2_AppEngineHttpRequest_descriptor;
}
@java.lang.Override
public com.google.cloud.tasks.v2.AppEngineHttpRequest getDefaultInstanceForType() {
return com.google.cloud.tasks.v2.AppEngineHttpRequest.getDefaultInstance();
}
@java.lang.Override
public com.google.cloud.tasks.v2.AppEngineHttpRequest build() {
com.google.cloud.tasks.v2.AppEngineHttpRequest result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public com.google.cloud.tasks.v2.AppEngineHttpRequest buildPartial() {
com.google.cloud.tasks.v2.AppEngineHttpRequest result =
new com.google.cloud.tasks.v2.AppEngineHttpRequest(this);
int from_bitField0_ = bitField0_;
result.httpMethod_ = httpMethod_;
if (appEngineRoutingBuilder_ == null) {
result.appEngineRouting_ = appEngineRouting_;
} else {