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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="networkservices_v1.html">Network Services API</a> . <a href="networkservices_v1.projects.html">projects</a> . <a href="networkservices_v1.projects.locations.html">locations</a> . <a href="networkservices_v1.projects.locations.httpRoutes.html">httpRoutes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, httpRouteId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new HttpRoute in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single HttpRoute.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single HttpRoute.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists HttpRoute in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single HttpRoute.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, httpRouteId=None, x__xgafv=None)</code>
<pre>Creates a new HttpRoute in a given project and location.
Args:
parent: string, Required. The parent resource of the HttpRoute. Must be in the format `projects/*/locations/global`. (required)
body: object, The request body.
The object takes the form of:
{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
"createTime": "A String", # Output only. The timestamp when the resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`
"A String",
],
"hostnames": [ # Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`.
"A String",
],
"labels": { # Optional. Set of label tags associated with the HttpRoute resource.
"a_key": "A String",
},
"meshes": [ # Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR
"A String",
],
"name": "A String", # Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
"rules": [ # Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
{ # Specifies how to match traffic and how to route traffic when traffic is matched.
"action": { # The specifications for routing traffic and applying associated policies. # The detailed rule defining how to route matched traffic.
"corsPolicy": { # The Specification for allowing client side cross-origin requests. # The specification for allowing client side cross-origin requests.
"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default value is false.
"allowHeaders": [ # Specifies the content for Access-Control-Allow-Headers header.
"A String",
],
"allowMethods": [ # Specifies the content for Access-Control-Allow-Methods header.
"A String",
],
"allowOriginRegexes": [ # Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.
"A String",
],
"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allow_origins or an item in allow_origin_regexes.
"A String",
],
"disabled": True or False, # If true, the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
"exposeHeaders": [ # Specifies the content for Access-Control-Expose-Headers header.
"A String",
],
"maxAge": "A String", # Specifies how long result of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
},
"destinations": [ # The destination to which traffic should be forwarded.
{ # Specifications of a destination to which the request should be routed to.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
],
"directResponse": { # Static HTTP response object to be returned. # Optional. Static HTTP Response object to be returned regardless of the request.
"bytesBody": "A String", # Optional. Response body as bytes. Maximum body size is 4096B.
"status": 42, # Required. Status to return as part of HTTP Response. Must be a positive integer.
"stringBody": "A String", # Optional. Response body as a string. Maximum body length is 1024 characters.
},
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced by client proxy on a percentage of requests before sending those requests to the destination service. Similarly requests can be aborted by client proxy for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
"abort": { # Specification of how client requests are aborted as part of fault injection before being sent to a destination. # The specification for aborting to client requests.
"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
"percentage": 42, # The percentage of traffic which will be aborted. The value must be between [0, 100]
},
"delay": { # Specification of how client requests are delayed as part of fault injection before being sent to a destination. # The specification for injecting delay to client requests.
"fixedDelay": "A String", # Specify a fixed delay before forwarding the request.
"percentage": 42, # The percentage of traffic on which delay will be injected. The value must be between [0, 100]
},
},
"idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
"redirect": { # The specification for redirecting traffic. # If set, the request is directed as configured by this field.
"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.
"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.
"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
"portRedirect": 42, # The port that will be used in the redirected request instead of the one that was supplied in the request.
"prefixRewrite": "A String", # Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
"responseCode": "A String", # The HTTP Status code to use for the redirect.
"stripQuery": True or False, # if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
},
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"requestMirrorPolicy": { # Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow. Mirroring is currently not supported for Cloud Run destinations. # Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
"destination": { # Specifications of a destination to which the request should be routed to. # The destination the requests will be mirrored to. The weight of the destination will be ignored.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
"mirrorPercent": 3.14, # Optional. The percentage of requests to get mirrored to the desired destination.
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"retryPolicy": { # The specifications for retries. # Specifies the retry policy associated with this route.
"numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.
"perTryTimeout": "A String", # Specifies a non-zero timeout per retry attempt.
"retryConditions": [ # Specifies one or more conditions when this retry policy applies. Valid values are: 5xx: Proxy will attempt a retry if the destination service responds with any 5xx response code, of if the destination service does not respond at all, example: disconnect, reset, read timeout, connection failure and refused streams. gateway-error: Similar to 5xx, but only applies to response codes 502, 503, 504. reset: Proxy will attempt a retry if the destination service does not respond at all (disconnect/reset/read timeout) connect-failure: Proxy will retry on failures connecting to destination for example due to connection timeouts. retriable-4xx: Proxy will retry fro retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream: Proxy will retry if the destination resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
"A String",
],
},
"statefulSessionAffinity": { # The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. # Optional. Specifies cookie-based stateful session affinity.
"cookieTtl": "A String", # Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.
},
"timeout": "A String", # Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
"urlRewrite": { # The specification for modifying the URL of the request, prior to forwarding the request to the destination. # The specification for rewrite URL before forwarding requests to the destination.
"hostRewrite": "A String", # Prior to forwarding the request to the selected destination, the requests host header is replaced by this value.
"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected destination, the matching portion of the requests path is replaced by this value.
},
},
"matches": [ # A list of matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic. If a default rule is desired to be configured, add a rule with no matches specified to the end of the rules list.
{ # RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.
"fullPathMatch": "A String", # The HTTP request path value should exactly match this value. Only one of full_path_match, prefix_match, or regex_match should be used.
"headers": [ # Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.
{ # Specifies how to select a route rule based on HTTP request headers.
"exactMatch": "A String", # The value of the header should match exactly the content of exact_match.
"header": "A String", # The name of the HTTP header to match against.
"invertMatch": True or False, # If specified, the match result will be inverted before checking. Default value is set to false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefix_match.
"presentMatch": True or False, # A header with header_name must exist. The match takes place whether or not the header has a value.
"rangeMatch": { # Represents an integer value range. # If specified, the rule will match if the request header value is within the range.
"end": 42, # End of the range (exclusive)
"start": 42, # Start of the range (inclusive)
},
"regexMatch": "A String", # The value of the header must match the regular expression specified in regex_match. For regular expression grammar, please see: https://github.com/google/re2/wiki/Syntax
"suffixMatch": "A String", # The value of the header must end with the contents of suffix_match.
},
],
"ignoreCase": True or False, # Specifies if prefix_match and full_path_match matches are case sensitive. The default value is false.
"prefixMatch": "A String", # The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /. Only one of full_path_match, prefix_match, or regex_match should be used.
"queryParameters": [ # Specifies a list of query parameters to match against. ALL of the query parameters must be matched.
{ # Specifications to match a query parameter in the request.
"exactMatch": "A String", # The value of the query parameter must exactly match the contents of exact_match. Only one of exact_match, regex_match, or present_match must be set.
"presentMatch": True or False, # Specifies that the QueryParameterMatcher matches if request contains query parameter, irrespective of whether the parameter has a value or not. Only one of exact_match, regex_match, or present_match must be set.
"queryParameter": "A String", # The name of the query parameter to match.
"regexMatch": "A String", # The value of the query parameter must match the regular expression specified by regex_match. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of exact_match, regex_match, or present_match must be set.
},
],
"regexMatch": "A String", # The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of full_path_match, prefix_match, or regex_match should be used.
},
],
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
httpRouteId: string, Required. Short name of the HttpRoute resource to be created.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a single HttpRoute.
Args:
name: string, Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single HttpRoute.
Args:
name: string, Required. A name of the HttpRoute to get. Must be in the format `projects/*/locations/global/httpRoutes/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
"createTime": "A String", # Output only. The timestamp when the resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`
"A String",
],
"hostnames": [ # Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`.
"A String",
],
"labels": { # Optional. Set of label tags associated with the HttpRoute resource.
"a_key": "A String",
},
"meshes": [ # Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR
"A String",
],
"name": "A String", # Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
"rules": [ # Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
{ # Specifies how to match traffic and how to route traffic when traffic is matched.
"action": { # The specifications for routing traffic and applying associated policies. # The detailed rule defining how to route matched traffic.
"corsPolicy": { # The Specification for allowing client side cross-origin requests. # The specification for allowing client side cross-origin requests.
"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default value is false.
"allowHeaders": [ # Specifies the content for Access-Control-Allow-Headers header.
"A String",
],
"allowMethods": [ # Specifies the content for Access-Control-Allow-Methods header.
"A String",
],
"allowOriginRegexes": [ # Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.
"A String",
],
"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allow_origins or an item in allow_origin_regexes.
"A String",
],
"disabled": True or False, # If true, the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
"exposeHeaders": [ # Specifies the content for Access-Control-Expose-Headers header.
"A String",
],
"maxAge": "A String", # Specifies how long result of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
},
"destinations": [ # The destination to which traffic should be forwarded.
{ # Specifications of a destination to which the request should be routed to.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
],
"directResponse": { # Static HTTP response object to be returned. # Optional. Static HTTP Response object to be returned regardless of the request.
"bytesBody": "A String", # Optional. Response body as bytes. Maximum body size is 4096B.
"status": 42, # Required. Status to return as part of HTTP Response. Must be a positive integer.
"stringBody": "A String", # Optional. Response body as a string. Maximum body length is 1024 characters.
},
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced by client proxy on a percentage of requests before sending those requests to the destination service. Similarly requests can be aborted by client proxy for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
"abort": { # Specification of how client requests are aborted as part of fault injection before being sent to a destination. # The specification for aborting to client requests.
"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
"percentage": 42, # The percentage of traffic which will be aborted. The value must be between [0, 100]
},
"delay": { # Specification of how client requests are delayed as part of fault injection before being sent to a destination. # The specification for injecting delay to client requests.
"fixedDelay": "A String", # Specify a fixed delay before forwarding the request.
"percentage": 42, # The percentage of traffic on which delay will be injected. The value must be between [0, 100]
},
},
"idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
"redirect": { # The specification for redirecting traffic. # If set, the request is directed as configured by this field.
"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.
"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.
"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
"portRedirect": 42, # The port that will be used in the redirected request instead of the one that was supplied in the request.
"prefixRewrite": "A String", # Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
"responseCode": "A String", # The HTTP Status code to use for the redirect.
"stripQuery": True or False, # if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
},
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"requestMirrorPolicy": { # Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow. Mirroring is currently not supported for Cloud Run destinations. # Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
"destination": { # Specifications of a destination to which the request should be routed to. # The destination the requests will be mirrored to. The weight of the destination will be ignored.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
"mirrorPercent": 3.14, # Optional. The percentage of requests to get mirrored to the desired destination.
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"retryPolicy": { # The specifications for retries. # Specifies the retry policy associated with this route.
"numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.
"perTryTimeout": "A String", # Specifies a non-zero timeout per retry attempt.
"retryConditions": [ # Specifies one or more conditions when this retry policy applies. Valid values are: 5xx: Proxy will attempt a retry if the destination service responds with any 5xx response code, of if the destination service does not respond at all, example: disconnect, reset, read timeout, connection failure and refused streams. gateway-error: Similar to 5xx, but only applies to response codes 502, 503, 504. reset: Proxy will attempt a retry if the destination service does not respond at all (disconnect/reset/read timeout) connect-failure: Proxy will retry on failures connecting to destination for example due to connection timeouts. retriable-4xx: Proxy will retry fro retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream: Proxy will retry if the destination resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
"A String",
],
},
"statefulSessionAffinity": { # The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. # Optional. Specifies cookie-based stateful session affinity.
"cookieTtl": "A String", # Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.
},
"timeout": "A String", # Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
"urlRewrite": { # The specification for modifying the URL of the request, prior to forwarding the request to the destination. # The specification for rewrite URL before forwarding requests to the destination.
"hostRewrite": "A String", # Prior to forwarding the request to the selected destination, the requests host header is replaced by this value.
"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected destination, the matching portion of the requests path is replaced by this value.
},
},
"matches": [ # A list of matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic. If a default rule is desired to be configured, add a rule with no matches specified to the end of the rules list.
{ # RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.
"fullPathMatch": "A String", # The HTTP request path value should exactly match this value. Only one of full_path_match, prefix_match, or regex_match should be used.
"headers": [ # Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.
{ # Specifies how to select a route rule based on HTTP request headers.
"exactMatch": "A String", # The value of the header should match exactly the content of exact_match.
"header": "A String", # The name of the HTTP header to match against.
"invertMatch": True or False, # If specified, the match result will be inverted before checking. Default value is set to false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefix_match.
"presentMatch": True or False, # A header with header_name must exist. The match takes place whether or not the header has a value.
"rangeMatch": { # Represents an integer value range. # If specified, the rule will match if the request header value is within the range.
"end": 42, # End of the range (exclusive)
"start": 42, # Start of the range (inclusive)
},
"regexMatch": "A String", # The value of the header must match the regular expression specified in regex_match. For regular expression grammar, please see: https://github.com/google/re2/wiki/Syntax
"suffixMatch": "A String", # The value of the header must end with the contents of suffix_match.
},
],
"ignoreCase": True or False, # Specifies if prefix_match and full_path_match matches are case sensitive. The default value is false.
"prefixMatch": "A String", # The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /. Only one of full_path_match, prefix_match, or regex_match should be used.
"queryParameters": [ # Specifies a list of query parameters to match against. ALL of the query parameters must be matched.
{ # Specifications to match a query parameter in the request.
"exactMatch": "A String", # The value of the query parameter must exactly match the contents of exact_match. Only one of exact_match, regex_match, or present_match must be set.
"presentMatch": True or False, # Specifies that the QueryParameterMatcher matches if request contains query parameter, irrespective of whether the parameter has a value or not. Only one of exact_match, regex_match, or present_match must be set.
"queryParameter": "A String", # The name of the query parameter to match.
"regexMatch": "A String", # The value of the query parameter must match the regular expression specified by regex_match. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of exact_match, regex_match, or present_match must be set.
},
],
"regexMatch": "A String", # The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of full_path_match, prefix_match, or regex_match should be used.
},
],
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Lists HttpRoute in a given project and location.
Args:
parent: string, Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/*/locations/global`. (required)
pageSize: integer, Maximum number of HttpRoutes to return per call.
pageToken: string, The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data.
returnPartialSuccess: boolean, Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response returned by the ListHttpRoutes method.
"httpRoutes": [ # List of HttpRoute resources.
{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
"createTime": "A String", # Output only. The timestamp when the resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`
"A String",
],
"hostnames": [ # Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`.
"A String",
],
"labels": { # Optional. Set of label tags associated with the HttpRoute resource.
"a_key": "A String",
},
"meshes": [ # Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR
"A String",
],
"name": "A String", # Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
"rules": [ # Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
{ # Specifies how to match traffic and how to route traffic when traffic is matched.
"action": { # The specifications for routing traffic and applying associated policies. # The detailed rule defining how to route matched traffic.
"corsPolicy": { # The Specification for allowing client side cross-origin requests. # The specification for allowing client side cross-origin requests.
"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default value is false.
"allowHeaders": [ # Specifies the content for Access-Control-Allow-Headers header.
"A String",
],
"allowMethods": [ # Specifies the content for Access-Control-Allow-Methods header.
"A String",
],
"allowOriginRegexes": [ # Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.
"A String",
],
"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allow_origins or an item in allow_origin_regexes.
"A String",
],
"disabled": True or False, # If true, the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
"exposeHeaders": [ # Specifies the content for Access-Control-Expose-Headers header.
"A String",
],
"maxAge": "A String", # Specifies how long result of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
},
"destinations": [ # The destination to which traffic should be forwarded.
{ # Specifications of a destination to which the request should be routed to.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
],
"directResponse": { # Static HTTP response object to be returned. # Optional. Static HTTP Response object to be returned regardless of the request.
"bytesBody": "A String", # Optional. Response body as bytes. Maximum body size is 4096B.
"status": 42, # Required. Status to return as part of HTTP Response. Must be a positive integer.
"stringBody": "A String", # Optional. Response body as a string. Maximum body length is 1024 characters.
},
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced by client proxy on a percentage of requests before sending those requests to the destination service. Similarly requests can be aborted by client proxy for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
"abort": { # Specification of how client requests are aborted as part of fault injection before being sent to a destination. # The specification for aborting to client requests.
"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
"percentage": 42, # The percentage of traffic which will be aborted. The value must be between [0, 100]
},
"delay": { # Specification of how client requests are delayed as part of fault injection before being sent to a destination. # The specification for injecting delay to client requests.
"fixedDelay": "A String", # Specify a fixed delay before forwarding the request.
"percentage": 42, # The percentage of traffic on which delay will be injected. The value must be between [0, 100]
},
},
"idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
"redirect": { # The specification for redirecting traffic. # If set, the request is directed as configured by this field.
"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.
"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.
"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
"portRedirect": 42, # The port that will be used in the redirected request instead of the one that was supplied in the request.
"prefixRewrite": "A String", # Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
"responseCode": "A String", # The HTTP Status code to use for the redirect.
"stripQuery": True or False, # if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
},
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"requestMirrorPolicy": { # Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow. Mirroring is currently not supported for Cloud Run destinations. # Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
"destination": { # Specifications of a destination to which the request should be routed to. # The destination the requests will be mirrored to. The weight of the destination will be ignored.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
"mirrorPercent": 3.14, # Optional. The percentage of requests to get mirrored to the desired destination.
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"retryPolicy": { # The specifications for retries. # Specifies the retry policy associated with this route.
"numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.
"perTryTimeout": "A String", # Specifies a non-zero timeout per retry attempt.
"retryConditions": [ # Specifies one or more conditions when this retry policy applies. Valid values are: 5xx: Proxy will attempt a retry if the destination service responds with any 5xx response code, of if the destination service does not respond at all, example: disconnect, reset, read timeout, connection failure and refused streams. gateway-error: Similar to 5xx, but only applies to response codes 502, 503, 504. reset: Proxy will attempt a retry if the destination service does not respond at all (disconnect/reset/read timeout) connect-failure: Proxy will retry on failures connecting to destination for example due to connection timeouts. retriable-4xx: Proxy will retry fro retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream: Proxy will retry if the destination resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
"A String",
],
},
"statefulSessionAffinity": { # The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. # Optional. Specifies cookie-based stateful session affinity.
"cookieTtl": "A String", # Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.
},
"timeout": "A String", # Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
"urlRewrite": { # The specification for modifying the URL of the request, prior to forwarding the request to the destination. # The specification for rewrite URL before forwarding requests to the destination.
"hostRewrite": "A String", # Prior to forwarding the request to the selected destination, the requests host header is replaced by this value.
"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected destination, the matching portion of the requests path is replaced by this value.
},
},
"matches": [ # A list of matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic. If a default rule is desired to be configured, add a rule with no matches specified to the end of the rules list.
{ # RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.
"fullPathMatch": "A String", # The HTTP request path value should exactly match this value. Only one of full_path_match, prefix_match, or regex_match should be used.
"headers": [ # Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.
{ # Specifies how to select a route rule based on HTTP request headers.
"exactMatch": "A String", # The value of the header should match exactly the content of exact_match.
"header": "A String", # The name of the HTTP header to match against.
"invertMatch": True or False, # If specified, the match result will be inverted before checking. Default value is set to false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefix_match.
"presentMatch": True or False, # A header with header_name must exist. The match takes place whether or not the header has a value.
"rangeMatch": { # Represents an integer value range. # If specified, the rule will match if the request header value is within the range.
"end": 42, # End of the range (exclusive)
"start": 42, # Start of the range (inclusive)
},
"regexMatch": "A String", # The value of the header must match the regular expression specified in regex_match. For regular expression grammar, please see: https://github.com/google/re2/wiki/Syntax
"suffixMatch": "A String", # The value of the header must end with the contents of suffix_match.
},
],
"ignoreCase": True or False, # Specifies if prefix_match and full_path_match matches are case sensitive. The default value is false.
"prefixMatch": "A String", # The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /. Only one of full_path_match, prefix_match, or regex_match should be used.
"queryParameters": [ # Specifies a list of query parameters to match against. ALL of the query parameters must be matched.
{ # Specifications to match a query parameter in the request.
"exactMatch": "A String", # The value of the query parameter must exactly match the contents of exact_match. Only one of exact_match, regex_match, or present_match must be set.
"presentMatch": True or False, # Specifies that the QueryParameterMatcher matches if request contains query parameter, irrespective of whether the parameter has a value or not. Only one of exact_match, regex_match, or present_match must be set.
"queryParameter": "A String", # The name of the query parameter to match.
"regexMatch": "A String", # The value of the query parameter must match the regular expression specified by regex_match. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of exact_match, regex_match, or present_match must be set.
},
],
"regexMatch": "A String", # The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of full_path_match, prefix_match, or regex_match should be used.
},
],
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
},
],
"nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
"unreachable": [ # Unreachable resources. Populated when the request opts into return_partial_success and reading across collections e.g. when attempting to list all resources across all supported locations.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single HttpRoute.
Args:
name: string, Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`. (required)
body: object, The request body.
The object takes the form of:
{ # HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
"createTime": "A String", # Output only. The timestamp when the resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"gateways": [ # Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`
"A String",
],
"hostnames": [ # Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`.
"A String",
],
"labels": { # Optional. Set of label tags associated with the HttpRoute resource.
"a_key": "A String",
},
"meshes": [ # Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR
"A String",
],
"name": "A String", # Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
"rules": [ # Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
{ # Specifies how to match traffic and how to route traffic when traffic is matched.
"action": { # The specifications for routing traffic and applying associated policies. # The detailed rule defining how to route matched traffic.
"corsPolicy": { # The Specification for allowing client side cross-origin requests. # The specification for allowing client side cross-origin requests.
"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default value is false.
"allowHeaders": [ # Specifies the content for Access-Control-Allow-Headers header.
"A String",
],
"allowMethods": [ # Specifies the content for Access-Control-Allow-Methods header.
"A String",
],
"allowOriginRegexes": [ # Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.
"A String",
],
"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allow_origins or an item in allow_origin_regexes.
"A String",
],
"disabled": True or False, # If true, the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
"exposeHeaders": [ # Specifies the content for Access-Control-Expose-Headers header.
"A String",
],
"maxAge": "A String", # Specifies how long result of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
},
"destinations": [ # The destination to which traffic should be forwarded.
{ # Specifications of a destination to which the request should be routed to.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
],
"directResponse": { # Static HTTP response object to be returned. # Optional. Static HTTP Response object to be returned regardless of the request.
"bytesBody": "A String", # Optional. Response body as bytes. Maximum body size is 4096B.
"status": 42, # Required. Status to return as part of HTTP Response. Must be a positive integer.
"stringBody": "A String", # Optional. Response body as a string. Maximum body length is 1024 characters.
},
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced by client proxy on a percentage of requests before sending those requests to the destination service. Similarly requests can be aborted by client proxy for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
"abort": { # Specification of how client requests are aborted as part of fault injection before being sent to a destination. # The specification for aborting to client requests.
"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
"percentage": 42, # The percentage of traffic which will be aborted. The value must be between [0, 100]
},
"delay": { # Specification of how client requests are delayed as part of fault injection before being sent to a destination. # The specification for injecting delay to client requests.
"fixedDelay": "A String", # Specify a fixed delay before forwarding the request.
"percentage": 42, # The percentage of traffic on which delay will be injected. The value must be between [0, 100]
},
},
"idleTimeout": "A String", # Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
"redirect": { # The specification for redirecting traffic. # If set, the request is directed as configured by this field.
"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.
"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.
"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
"portRedirect": 42, # The port that will be used in the redirected request instead of the one that was supplied in the request.
"prefixRewrite": "A String", # Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
"responseCode": "A String", # The HTTP Status code to use for the redirect.
"stripQuery": True or False, # if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
},
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"requestMirrorPolicy": { # Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow. Mirroring is currently not supported for Cloud Run destinations. # Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
"destination": { # Specifications of a destination to which the request should be routed to. # The destination the requests will be mirrored to. The weight of the destination will be ignored.
"requestHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"serviceName": "A String", # The URL of a BackendService to route traffic to.
"weight": 42, # Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
},
"mirrorPercent": 3.14, # Optional. The percentage of requests to get mirrored to the desired destination.
},
"responseHeaderModifier": { # The specification for modifying HTTP header in HTTP request and HTTP response. # The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
"add": { # Add the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
"remove": [ # Remove headers (matching by header names) specified in the list.
"A String",
],
"set": { # Completely overwrite/replace the headers with given map where key is the name of the header, value is the value of the header.
"a_key": "A String",
},
},
"retryPolicy": { # The specifications for retries. # Specifies the retry policy associated with this route.
"numRetries": 42, # Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.
"perTryTimeout": "A String", # Specifies a non-zero timeout per retry attempt.
"retryConditions": [ # Specifies one or more conditions when this retry policy applies. Valid values are: 5xx: Proxy will attempt a retry if the destination service responds with any 5xx response code, of if the destination service does not respond at all, example: disconnect, reset, read timeout, connection failure and refused streams. gateway-error: Similar to 5xx, but only applies to response codes 502, 503, 504. reset: Proxy will attempt a retry if the destination service does not respond at all (disconnect/reset/read timeout) connect-failure: Proxy will retry on failures connecting to destination for example due to connection timeouts. retriable-4xx: Proxy will retry fro retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream: Proxy will retry if the destination resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
"A String",
],
},
"statefulSessionAffinity": { # The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. # Optional. Specifies cookie-based stateful session affinity.
"cookieTtl": "A String", # Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.
},
"timeout": "A String", # Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
"urlRewrite": { # The specification for modifying the URL of the request, prior to forwarding the request to the destination. # The specification for rewrite URL before forwarding requests to the destination.
"hostRewrite": "A String", # Prior to forwarding the request to the selected destination, the requests host header is replaced by this value.
"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected destination, the matching portion of the requests path is replaced by this value.
},
},
"matches": [ # A list of matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic. If a default rule is desired to be configured, add a rule with no matches specified to the end of the rules list.
{ # RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.
"fullPathMatch": "A String", # The HTTP request path value should exactly match this value. Only one of full_path_match, prefix_match, or regex_match should be used.
"headers": [ # Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.
{ # Specifies how to select a route rule based on HTTP request headers.
"exactMatch": "A String", # The value of the header should match exactly the content of exact_match.
"header": "A String", # The name of the HTTP header to match against.
"invertMatch": True or False, # If specified, the match result will be inverted before checking. Default value is set to false.
"prefixMatch": "A String", # The value of the header must start with the contents of prefix_match.
"presentMatch": True or False, # A header with header_name must exist. The match takes place whether or not the header has a value.
"rangeMatch": { # Represents an integer value range. # If specified, the rule will match if the request header value is within the range.
"end": 42, # End of the range (exclusive)
"start": 42, # Start of the range (inclusive)
},
"regexMatch": "A String", # The value of the header must match the regular expression specified in regex_match. For regular expression grammar, please see: https://github.com/google/re2/wiki/Syntax
"suffixMatch": "A String", # The value of the header must end with the contents of suffix_match.
},
],
"ignoreCase": True or False, # Specifies if prefix_match and full_path_match matches are case sensitive. The default value is false.
"prefixMatch": "A String", # The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /. Only one of full_path_match, prefix_match, or regex_match should be used.
"queryParameters": [ # Specifies a list of query parameters to match against. ALL of the query parameters must be matched.
{ # Specifications to match a query parameter in the request.
"exactMatch": "A String", # The value of the query parameter must exactly match the contents of exact_match. Only one of exact_match, regex_match, or present_match must be set.
"presentMatch": True or False, # Specifies that the QueryParameterMatcher matches if request contains query parameter, irrespective of whether the parameter has a value or not. Only one of exact_match, regex_match, or present_match must be set.
"queryParameter": "A String", # The name of the query parameter to match.
"regexMatch": "A String", # The value of the query parameter must match the regular expression specified by regex_match. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of exact_match, regex_match, or present_match must be set.
},
],
"regexMatch": "A String", # The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax Only one of full_path_match, prefix_match, or regex_match should be used.
},
],
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
