-
Notifications
You must be signed in to change notification settings - Fork 202
/
computeurlmap_types.go
965 lines (804 loc) · 41.9 KB
/
computeurlmap_types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------
//
// *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
//
// ----------------------------------------------------------------------------
//
// This file is automatically generated by Config Connector and manual
// changes will be clobbered when the file is regenerated.
//
// ----------------------------------------------------------------------------
// *** DISCLAIMER ***
// Config Connector's go-client for CRDs is currently in ALPHA, which means
// that future versions of the go-client may include breaking changes.
// Please try it out and give us feedback!
package v1beta1
import (
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/k8s/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
type UrlmapAbort struct {
/* The HTTP status code used to abort the request. The value must be between 200
and 599 inclusive. */
// +optional
HttpStatus *int `json:"httpStatus,omitempty"`
/* The percentage of traffic (connections/operations/requests) which will be
aborted as part of fault injection. The value must be between 0.0 and 100.0
inclusive. */
// +optional
Percentage *float64 `json:"percentage,omitempty"`
}
type UrlmapCorsPolicy struct {
/* 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. Defaults to false. */
// +optional
AllowCredentials *bool `json:"allowCredentials,omitempty"`
/* Specifies the content for the Access-Control-Allow-Headers header. */
// +optional
AllowHeaders []string `json:"allowHeaders,omitempty"`
/* Specifies the content for the Access-Control-Allow-Methods header. */
// +optional
AllowMethods []string `json:"allowMethods,omitempty"`
/* Specifies the regular expression patterns that match allowed origins. For
regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript
An origin is allowed if it matches either allow_origins or allow_origin_regex. */
// +optional
AllowOriginRegexes []string `json:"allowOriginRegexes,omitempty"`
/* Specifies the list of origins that will be allowed to do CORS requests. An
origin is allowed if it matches either allow_origins or allow_origin_regex. */
// +optional
AllowOrigins []string `json:"allowOrigins,omitempty"`
/* If true, specifies the CORS policy is disabled.
which indicates that the CORS policy is in effect. Defaults to false. */
// +optional
Disabled *bool `json:"disabled,omitempty"`
/* Specifies the content for the Access-Control-Expose-Headers header. */
// +optional
ExposeHeaders []string `json:"exposeHeaders,omitempty"`
/* Specifies how long the results of a preflight request can be cached. This
translates to the content for the Access-Control-Max-Age header. */
// +optional
MaxAge *int `json:"maxAge,omitempty"`
}
type UrlmapDefaultRouteAction struct {
/* The specification for allowing client side cross-origin requests. Please see
[W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) */
// +optional
CorsPolicy *UrlmapCorsPolicy `json:"corsPolicy,omitempty"`
/* 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 by Loadbalancer on a
percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted
by the Loadbalancer for a percentage of requests.
timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. */
// +optional
FaultInjectionPolicy *UrlmapFaultInjectionPolicy `json:"faultInjectionPolicy,omitempty"`
/* Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service.
Loadbalancer 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. */
// +optional
RequestMirrorPolicy *UrlmapRequestMirrorPolicy `json:"requestMirrorPolicy,omitempty"`
/* Specifies the retry policy associated with this route. */
// +optional
RetryPolicy *UrlmapRetryPolicy `json:"retryPolicy,omitempty"`
/* Specifies the timeout for the 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.
If not specified, will use the largest timeout among all backend services associated with the route. */
// +optional
Timeout *UrlmapTimeout `json:"timeout,omitempty"`
/* The spec to modify the URL of the request, prior to forwarding the request to the matched service. */
// +optional
UrlRewrite *UrlmapUrlRewrite `json:"urlRewrite,omitempty"`
/* A list of weighted backend services to send traffic to when a route match occurs.
The weights determine the fraction of traffic that flows to their corresponding backend service.
If all traffic needs to go to a single backend service, there must be one weightedBackendService
with weight set to a non 0 number.
Once a backendService is identified and before forwarding the request to the backend service,
advanced routing actions like Url rewrites and header transformations are applied depending on
additional settings specified in this HttpRouteAction. */
// +optional
WeightedBackendServices []UrlmapWeightedBackendServices `json:"weightedBackendServices,omitempty"`
}
type UrlmapDefaultService struct {
/* */
// +optional
BackendBucketRef *v1alpha1.ResourceRef `json:"backendBucketRef,omitempty"`
/* */
// +optional
BackendServiceRef *v1alpha1.ResourceRef `json:"backendServiceRef,omitempty"`
}
type UrlmapDefaultUrlRedirect struct {
/* The host that will be used in the redirect response instead of the one that was
supplied in the request. The value must be between 1 and 255 characters. */
// +optional
HostRedirect *string `json:"hostRedirect,omitempty"`
/* 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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this
true for TargetHttpsProxy is not permitted. The default is set to false. */
// +optional
HttpsRedirect *bool `json:"httpsRedirect,omitempty"`
/* The path that will be used in the redirect response instead of the one that was
supplied in the request. pathRedirect cannot be supplied together with
prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the
original request will be used for the redirect. The value must be between 1 and 1024
characters. */
// +optional
PathRedirect *string `json:"pathRedirect,omitempty"`
/* The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the request.
prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or
neither. If neither is supplied, the path of the original request will be used for
the redirect. The value must be between 1 and 1024 characters. */
// +optional
PrefixRedirect *string `json:"prefixRedirect,omitempty"`
/* The HTTP Status code to use for this RedirectAction. Supported values are:
* MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method
will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case,
the request method will be retained. Possible values: ["FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"] */
// +optional
RedirectResponseCode *string `json:"redirectResponseCode,omitempty"`
/* 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.
This field is required to ensure an empty block is not set. The normal default value is false. */
StripQuery bool `json:"stripQuery"`
}
type UrlmapDelay struct {
/* Specifies the value of the fixed delay interval. */
// +optional
FixedDelay *UrlmapFixedDelay `json:"fixedDelay,omitempty"`
/* The percentage of traffic (connections/operations/requests) on which delay will
be introduced as part of fault injection. The value must be between 0.0 and
100.0 inclusive. */
// +optional
Percentage *float64 `json:"percentage,omitempty"`
}
type UrlmapFaultInjectionPolicy struct {
/* The specification for how client requests are aborted as part of fault
injection. */
// +optional
Abort *UrlmapAbort `json:"abort,omitempty"`
/* The specification for how client requests are delayed as part of fault
injection, before being sent to a backend service. */
// +optional
Delay *UrlmapDelay `json:"delay,omitempty"`
}
type UrlmapFilterLabels struct {
/* Name of metadata label. The name can have a maximum length of 1024 characters
and must be at least 1 character long. */
Name string `json:"name"`
/* The value of the label must match the specified value. value can have a maximum
length of 1024 characters. */
Value string `json:"value"`
}
type UrlmapFixedDelay struct {
/* Span of time that's a fraction of a second at nanosecond resolution. Durations
less than one second are represented with a 0 'seconds' field and a positive
'nanos' field. Must be from 0 to 999,999,999 inclusive. */
// +optional
Nanos *int `json:"nanos,omitempty"`
/* Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive. */
Seconds string `json:"seconds"`
}
type UrlmapHeaderAction struct {
/* Headers to add to a matching request prior to forwarding the request to the
backendService. */
// +optional
RequestHeadersToAdd []UrlmapRequestHeadersToAdd `json:"requestHeadersToAdd,omitempty"`
/* A list of header names for headers that need to be removed from the request
prior to forwarding the request to the backendService. */
// +optional
RequestHeadersToRemove []string `json:"requestHeadersToRemove,omitempty"`
/* Headers to add the response prior to sending the response back to the client. */
// +optional
ResponseHeadersToAdd []UrlmapResponseHeadersToAdd `json:"responseHeadersToAdd,omitempty"`
/* A list of header names for headers that need to be removed from the response
prior to sending the response back to the client. */
// +optional
ResponseHeadersToRemove []string `json:"responseHeadersToRemove,omitempty"`
}
type UrlmapHeaderMatches struct {
/* The value should exactly match contents of exactMatch. Only one of exactMatch,
prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */
// +optional
ExactMatch *string `json:"exactMatch,omitempty"`
/* The name of the HTTP header to match. For matching against the HTTP request's
authority, use a headerMatch with the header name ":authority". For matching a
request's method, use the headerName ":method". */
HeaderName string `json:"headerName"`
/* If set to false, the headerMatch is considered a match if the match criteria
above are met. If set to true, the headerMatch is considered a match if the
match criteria above are NOT met. Defaults to false. */
// +optional
InvertMatch *bool `json:"invertMatch,omitempty"`
/* The value of the header must start with the contents of prefixMatch. Only one of
exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch
must be set. */
// +optional
PrefixMatch *string `json:"prefixMatch,omitempty"`
/* A header with the contents of headerName must exist. The match takes place
whether or not the request's header has a value or not. Only one of exactMatch,
prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */
// +optional
PresentMatch *bool `json:"presentMatch,omitempty"`
/* The header value must be an integer and its value must be in the range specified
in rangeMatch. If the header does not contain an integer, number or is empty,
the match fails. For example for a range [-5, 0]
* -3 will match
* 0 will not match
* 0.25 will not match
* -3someString will not match.
Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
rangeMatch must be set. */
// +optional
RangeMatch *UrlmapRangeMatch `json:"rangeMatch,omitempty"`
/* The value of the header must match the regular expression specified in
regexMatch. For regular expression grammar, please see:
en.cppreference.com/w/cpp/regex/ecmascript For matching against a port
specified in the HTTP request, use a headerMatch with headerName set to PORT and
a regular expression that satisfies the RFC2616 Host header's port specifier.
Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
rangeMatch must be set. */
// +optional
RegexMatch *string `json:"regexMatch,omitempty"`
/* The value of the header must end with the contents of suffixMatch. Only one of
exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch
must be set. */
// +optional
SuffixMatch *string `json:"suffixMatch,omitempty"`
}
type UrlmapHostRule struct {
/* An optional description of this HostRule. Provide this property
when you create the resource. */
// +optional
Description *string `json:"description,omitempty"`
/* The list of host patterns to match. They must be valid
hostnames, except * will match any string of ([a-z0-9-.]*). In
that case, * must be the first character and must be followed in
the pattern by either - or .. */
Hosts []string `json:"hosts"`
/* The name of the PathMatcher to use to match the path portion of
the URL if the hostRule matches the URL's host portion. */
PathMatcher string `json:"pathMatcher"`
}
type UrlmapMatchRules struct {
/* For satisfying the matchRule condition, the path of the request must exactly
match the value specified in fullPathMatch after removing any query parameters
and anchor that may be part of the original URL. FullPathMatch must be between 1
and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must
be specified. */
// +optional
FullPathMatch *string `json:"fullPathMatch,omitempty"`
/* Specifies a list of header match criteria, all of which must match corresponding
headers in the request. */
// +optional
HeaderMatches []UrlmapHeaderMatches `json:"headerMatches,omitempty"`
/* Specifies that prefixMatch and fullPathMatch matches are case sensitive.
Defaults to false. */
// +optional
IgnoreCase *bool `json:"ignoreCase,omitempty"`
/* Opaque filter criteria used by Loadbalancer to restrict routing configuration to
a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS
clients present node metadata. If a match takes place, the relevant routing
configuration is made available to those proxies. For each metadataFilter in
this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the
filterLabels must match the corresponding label provided in the metadata. If its
filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match
with corresponding labels in the provided metadata. metadataFilters specified
here can be overrides those specified in ForwardingRule that refers to this
UrlMap. metadataFilters only applies to Loadbalancers that have their
loadBalancingScheme set to INTERNAL_SELF_MANAGED. */
// +optional
MetadataFilters []UrlmapMetadataFilters `json:"metadataFilters,omitempty"`
/* For satisfying the matchRule condition, the request's path must begin with the
specified prefixMatch. prefixMatch must begin with a /. The value must be
between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or
regexMatch must be specified. */
// +optional
PrefixMatch *string `json:"prefixMatch,omitempty"`
/* Specifies a list of query parameter match criteria, all of which must match
corresponding query parameters in the request. */
// +optional
QueryParameterMatches []UrlmapQueryParameterMatches `json:"queryParameterMatches,omitempty"`
/* For satisfying the matchRule condition, the path of the request must satisfy the
regular expression specified in regexMatch after removing any query parameters
and anchor supplied with the original URL. For regular expression grammar please
see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch,
fullPathMatch or regexMatch must be specified. */
// +optional
RegexMatch *string `json:"regexMatch,omitempty"`
}
type UrlmapMetadataFilters struct {
/* The list of label value pairs that must match labels in the provided metadata
based on filterMatchCriteria This list must not be empty and can have at the
most 64 entries. */
FilterLabels []UrlmapFilterLabels `json:"filterLabels"`
/* Specifies how individual filterLabel matches within the list of filterLabels
contribute towards the overall metadataFilter match. Supported values are:
* MATCH_ANY: At least one of the filterLabels must have a matching label in the
provided metadata.
* MATCH_ALL: All filterLabels must have matching labels in
the provided metadata. Possible values: ["MATCH_ALL", "MATCH_ANY"] */
FilterMatchCriteria string `json:"filterMatchCriteria"`
}
type UrlmapPathMatcher struct {
/* defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs
advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request
to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set.
Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.
Only one of defaultRouteAction or defaultUrlRedirect must be set. */
// +optional
DefaultRouteAction *UrlmapDefaultRouteAction `json:"defaultRouteAction,omitempty"`
/* The default service to use if none of the pathRules defined by this
PathMatcher is matched by the URL's path portion.
For the Global URL Map, it should be a reference to the backend
service or backend bucket.
For the Regional URL Map, it should be a reference to the backend
service. */
// +optional
DefaultService *UrlmapDefaultService `json:"defaultService,omitempty"`
/* When none of the specified hostRules match, the request is redirected to a URL specified
by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or
defaultRouteAction must not be set. */
// +optional
DefaultUrlRedirect *UrlmapDefaultUrlRedirect `json:"defaultUrlRedirect,omitempty"`
/* An optional description of this resource. */
// +optional
Description *string `json:"description,omitempty"`
/* Specifies changes to request and response headers that need to take effect for
the selected backendService. HeaderAction specified here are applied after the
matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap */
// +optional
HeaderAction *UrlmapHeaderAction `json:"headerAction,omitempty"`
/* The name to which this PathMatcher is referred by the HostRule. */
Name string `json:"name"`
/* The list of path rules. Use this list instead of routeRules when routing based
on simple path matching is all that's required. The order by which path rules
are specified does not matter. Matches are always done on the longest-path-first
basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/*
irrespective of the order in which those paths appear in this list. Within a
given pathMatcher, only one of pathRules or routeRules must be set. */
// +optional
PathRule []UrlmapPathRule `json:"pathRule,omitempty"`
/* The list of ordered HTTP route rules. Use this list instead of pathRules when
advanced route matching and routing actions are desired. The order of specifying
routeRules matters: the first rule that matches will cause its specified routing
action to take effect. Within a given pathMatcher, only one of pathRules or
routeRules must be set. routeRules are not supported in UrlMaps intended for
External load balancers. */
// +optional
RouteRules []UrlmapRouteRules `json:"routeRules,omitempty"`
}
type UrlmapPathRule struct {
/* The list of path patterns to match. Each must start with / and the only place a
\* is allowed is at the end following a /. The string fed to the path matcher
does not include any text after the first ? or #, and those chars are not
allowed here. */
Paths []string `json:"paths"`
/* In response to a matching path, the load balancer performs advanced routing
actions like URL rewrites, header transformations, etc. prior to forwarding the
request to the selected backend. If routeAction specifies any
weightedBackendServices, service must not be set. Conversely if service is set,
routeAction cannot contain any weightedBackendServices. Only one of routeAction
or urlRedirect must be set. */
// +optional
RouteAction *UrlmapRouteAction `json:"routeAction,omitempty"`
/* The backend service to which traffic is directed if this rule is
matched.
For the Global URL Map, it should be a reference to the backend
service or backend bucket.
For the Regional URL Map, it should be a reference to the backend
service.
If routeAction is additionally specified, advanced routing actions
like URL Rewrites, etc. take effect prior to sending the request to
the backend. However, if service is specified, routeAction cannot
contain any weightedBackendServices. Conversely, if routeAction
specifies any weightedBackendServices, service must not be
specified. Only one of urlRedirect, service or
routeAction.weightedBackendService must be set. */
// +optional
Service *UrlmapService `json:"service,omitempty"`
/* When a path pattern is matched, the request is redirected to a URL specified
by urlRedirect. If urlRedirect is specified, service or routeAction must not
be set. */
// +optional
UrlRedirect *UrlmapUrlRedirect `json:"urlRedirect,omitempty"`
}
type UrlmapPerTryTimeout struct {
/* Span of time that's a fraction of a second at nanosecond resolution. Durations
less than one second are represented with a 0 'seconds' field and a positive
'nanos' field. Must be from 0 to 999,999,999 inclusive. */
// +optional
Nanos *int `json:"nanos,omitempty"`
/* Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive. */
Seconds string `json:"seconds"`
}
type UrlmapQueryParameterMatches struct {
/* The queryParameterMatch matches if the value of the parameter exactly matches
the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch
must be set. */
// +optional
ExactMatch *string `json:"exactMatch,omitempty"`
/* The name of the query parameter to match. The query parameter must exist in the
request, in the absence of which the request match fails. */
Name string `json:"name"`
/* Specifies that the queryParameterMatch matches if the request contains the query
parameter, irrespective of whether the parameter has a value or not. Only one of
presentMatch, exactMatch and regexMatch must be set. */
// +optional
PresentMatch *bool `json:"presentMatch,omitempty"`
/* The queryParameterMatch matches if the value of the parameter matches the
regular expression specified by regexMatch. For the regular expression grammar,
please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch,
exactMatch and regexMatch must be set. */
// +optional
RegexMatch *string `json:"regexMatch,omitempty"`
}
type UrlmapRangeMatch struct {
/* The end of the range (exclusive). */
RangeEnd int `json:"rangeEnd"`
/* The start of the range (inclusive). */
RangeStart int `json:"rangeStart"`
}
type UrlmapRequestHeadersToAdd struct {
/* The name of the header. */
HeaderName string `json:"headerName"`
/* The value of the header to add. */
HeaderValue string `json:"headerValue"`
/* If false, headerValue is appended to any values that already exist for the
header. If true, headerValue is set for the header, discarding any values that
were set for that header. */
Replace bool `json:"replace"`
}
type UrlmapRequestMirrorPolicy struct {
/* Required. The backend service resource being mirrored to. */
BackendServiceRef v1alpha1.ResourceRef `json:"backendServiceRef"`
}
type UrlmapResponseHeadersToAdd struct {
/* The name of the header. */
HeaderName string `json:"headerName"`
/* The value of the header to add. */
HeaderValue string `json:"headerValue"`
/* If false, headerValue is appended to any values that already exist for the
header. If true, headerValue is set for the header, discarding any values that
were set for that header. */
Replace bool `json:"replace"`
}
type UrlmapRetryPolicy struct {
/* Specifies the allowed number retries. This number must be > 0. */
NumRetries int `json:"numRetries"`
/* Specifies a non-zero timeout per retry attempt. */
// +optional
PerTryTimeout *UrlmapPerTryTimeout `json:"perTryTimeout,omitempty"`
/* Specifies one or more conditions when this retry rule applies. Valid values are:
* 5xx: Loadbalancer will attempt a retry if the backend service responds with
any 5xx response code, or if the backend service does not respond at all,
example: disconnects, reset, read timeout, connection failure, and refused
streams.
* gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures
connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream: Loadbalancer will retry if the backend service resets the stream with a
REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response
header is set to cancelled
* deadline-exceeded: Loadbalancer will retry if the
gRPC status code in the response header is set to deadline-exceeded
* resource-exhausted: Loadbalancer will retry if the gRPC status code in the response
header is set to resource-exhausted
* unavailable: Loadbalancer will retry if the gRPC status code in
the response header is set to unavailable */
// +optional
RetryConditions []string `json:"retryConditions,omitempty"`
}
type UrlmapRouteAction struct {
/* The specification for allowing client side cross-origin requests. Please see W3C
Recommendation for Cross Origin Resource Sharing */
// +optional
CorsPolicy *UrlmapCorsPolicy `json:"corsPolicy,omitempty"`
/* 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 by
Loadbalancer on a percentage of requests before sending those request to the
backend service. Similarly requests from clients can be aborted by the
Loadbalancer for a percentage of requests. timeout and retry_policy will be
ignored by clients that are configured with a fault_injection_policy. */
// +optional
FaultInjectionPolicy *UrlmapFaultInjectionPolicy `json:"faultInjectionPolicy,omitempty"`
/* Specifies the policy on how requests intended for the route's backends are
shadowed to a separate mirrored backend service. Loadbalancer 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. */
// +optional
RequestMirrorPolicy *UrlmapRequestMirrorPolicy `json:"requestMirrorPolicy,omitempty"`
/* Specifies the retry policy associated with this route. */
// +optional
RetryPolicy *UrlmapRetryPolicy `json:"retryPolicy,omitempty"`
/* Specifies the timeout for the selected route. Timeout is computed from the time
the request is has been fully processed (i.e. end-of-stream) up until the
response has been completely processed. Timeout includes all retries. If not
specified, the default value is 15 seconds. */
// +optional
Timeout *UrlmapTimeout `json:"timeout,omitempty"`
/* The spec to modify the URL of the request, prior to forwarding the request to
the matched service */
// +optional
UrlRewrite *UrlmapUrlRewrite `json:"urlRewrite,omitempty"`
/* A list of weighted backend services to send traffic to when a route match
occurs. The weights determine the fraction of traffic that flows to their
corresponding backend service. If all traffic needs to go to a single backend
service, there must be one weightedBackendService with weight set to a non 0
number. Once a backendService is identified and before forwarding the request to
the backend service, advanced routing actions like Url rewrites and header
transformations are applied depending on additional settings specified in this
HttpRouteAction. */
// +optional
WeightedBackendServices []UrlmapWeightedBackendServices `json:"weightedBackendServices,omitempty"`
}
type UrlmapRouteRules struct {
/* Specifies changes to request and response headers that need to take effect for
the selected backendService. The headerAction specified here are applied before
the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].r
outeAction.weightedBackendService.backendServiceWeightAction[].headerAction */
// +optional
HeaderAction *UrlmapHeaderAction `json:"headerAction,omitempty"`
/* The rules for determining a match. */
// +optional
MatchRules []UrlmapMatchRules `json:"matchRules,omitempty"`
/* For routeRules within a given pathMatcher, priority determines the order
in which load balancer will interpret routeRules. RouteRules are evaluated
in order of priority, from the lowest to highest number. The priority of
a rule decreases as its number increases (1, 2, 3, N+1). The first rule
that matches the request is applied.
You cannot configure two or more routeRules with the same priority.
Priority for each rule must be set to a number between 0 and
2147483647 inclusive.
Priority numbers can have gaps, which enable you to add or remove rules
in the future without affecting the rest of the rules. For example,
1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which
you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the
future without any impact on existing rules. */
Priority int `json:"priority"`
/* In response to a matching matchRule, the load balancer performs advanced routing
actions like URL rewrites, header transformations, etc. prior to forwarding the
request to the selected backend. If routeAction specifies any
weightedBackendServices, service must not be set. Conversely if service is set,
routeAction cannot contain any weightedBackendServices. Only one of routeAction
or urlRedirect must be set. */
// +optional
RouteAction *UrlmapRouteAction `json:"routeAction,omitempty"`
/* The region backend service resource to which traffic is
directed if this rule is matched. If routeAction is additionally specified,
advanced routing actions like URL Rewrites, etc. take effect prior to sending
the request to the backend. However, if service is specified, routeAction cannot
contain any weightedBackendService s. Conversely, if routeAction specifies any
weightedBackendServices, service must not be specified. Only one of urlRedirect,
service or routeAction.weightedBackendService must be set. */
// +optional
Service *string `json:"service,omitempty"`
/* When this rule is matched, the request is redirected to a URL specified by
urlRedirect. If urlRedirect is specified, service or routeAction must not be
set. */
// +optional
UrlRedirect *UrlmapUrlRedirect `json:"urlRedirect,omitempty"`
}
type UrlmapService struct {
/* */
// +optional
BackendBucketRef *v1alpha1.ResourceRef `json:"backendBucketRef,omitempty"`
/* */
// +optional
BackendServiceRef *v1alpha1.ResourceRef `json:"backendServiceRef,omitempty"`
}
type UrlmapTest struct {
/* Description of this test case. */
// +optional
Description *string `json:"description,omitempty"`
/* Host portion of the URL. */
Host string `json:"host"`
/* Path portion of the URL. */
Path string `json:"path"`
/* The backend service resource that should be matched by this test.
For the Global URL Map, it should be a reference to the backend
service or backend bucket.
For the Regional URL Map, it should be a reference to the backend
service. */
Service UrlmapService `json:"service"`
}
type UrlmapTimeout struct {
/* Span of time that's a fraction of a second at nanosecond resolution. Durations
less than one second are represented with a 0 'seconds' field and a positive
'nanos' field. Must be from 0 to 999,999,999 inclusive. */
// +optional
Nanos *int `json:"nanos,omitempty"`
/* Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive. */
Seconds string `json:"seconds"`
}
type UrlmapUrlRedirect struct {
/* The host that will be used in the redirect response instead of the one
that was supplied in the request. The value must be between 1 and 255
characters. */
// +optional
HostRedirect *string `json:"hostRedirect,omitempty"`
/* 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. This must only be set for UrlMaps used in
TargetHttpProxys. Setting this true for TargetHttpsProxy is not
permitted. The default is set to false. */
// +optional
HttpsRedirect *bool `json:"httpsRedirect,omitempty"`
/* The path that will be used in the redirect response instead of the one
that was supplied in the request. pathRedirect cannot be supplied
together with prefixRedirect. Supply one alone or neither. If neither is
supplied, the path of the original request will be used for the redirect.
The value must be between 1 and 1024 characters. */
// +optional
PathRedirect *string `json:"pathRedirect,omitempty"`
/* The prefix that replaces the prefixMatch specified in the
HttpRouteRuleMatch, retaining the remaining portion of the URL before
redirecting the request. prefixRedirect cannot be supplied together with
pathRedirect. Supply one alone or neither. If neither is supplied, the
path of the original request will be used for the redirect. The value
must be between 1 and 1024 characters. */
// +optional
PrefixRedirect *string `json:"prefixRedirect,omitempty"`
/* The HTTP Status code to use for this RedirectAction. Supported values are:
* MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method
will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case,
the request method will be retained. Possible values: ["FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"] */
// +optional
RedirectResponseCode *string `json:"redirectResponseCode,omitempty"`
/* 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 value is false. */
// +optional
StripQuery *bool `json:"stripQuery,omitempty"`
}
type UrlmapUrlRewrite struct {
/* Prior to forwarding the request to the selected service, the request's host
header is replaced with contents of hostRewrite. The value must be between 1 and
255 characters. */
// +optional
HostRewrite *string `json:"hostRewrite,omitempty"`
/* Prior to forwarding the request to the selected backend service, the matching
portion of the request's path is replaced by pathPrefixRewrite. The value must
be between 1 and 1024 characters. */
// +optional
PathPrefixRewrite *string `json:"pathPrefixRewrite,omitempty"`
}
type UrlmapWeightedBackendServices struct {
/* Required. The default backend service resource. Before forwarding
the request to backendService, the loadbalancer applies any relevant
headerActions specified as part of this backendServiceWeight. */
BackendServiceRef v1alpha1.ResourceRef `json:"backendServiceRef"`
/* Specifies changes to request and response headers that need to take effect for
the selected backendService. headerAction specified here take effect before
headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. */
// +optional
HeaderAction *UrlmapHeaderAction `json:"headerAction,omitempty"`
/* Specifies the fraction of traffic sent to backendService, computed as weight /
(sum of all weightedBackendService weights in routeAction) . The selection of a
backend service is determined only for new traffic. Once a user's request has
been directed to a backendService, subsequent requests will be sent to the same
backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 */
Weight int `json:"weight"`
}
type ComputeURLMapSpec struct {
/* defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions
like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend.
If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService
is set, defaultRouteAction cannot contain any weightedBackendServices.
Only one of defaultRouteAction or defaultUrlRedirect must be set. */
// +optional
DefaultRouteAction *UrlmapDefaultRouteAction `json:"defaultRouteAction,omitempty"`
/* The defaultService resource to which traffic is directed if none of
the hostRules match.
For the Global URL Map, it should be a reference to the backend
service or backend bucket.
For the Regional URL Map, it should be a reference to the backend
service.
If defaultRouteAction is additionally specified, advanced routing
actions like URL Rewrites, etc. take effect prior to sending the
request to the backend. However, if defaultService is specified,
defaultRouteAction cannot contain any weightedBackendServices.
Conversely, if routeAction specifies any weightedBackendServices,
service must not be specified. Only one of defaultService,
defaultUrlRedirect or defaultRouteAction.weightedBackendService
must be set. */
// +optional
DefaultService *UrlmapDefaultService `json:"defaultService,omitempty"`
/* When none of the specified hostRules match, the request is redirected to a URL specified
by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or
defaultRouteAction must not be set. */
// +optional
DefaultUrlRedirect *UrlmapDefaultUrlRedirect `json:"defaultUrlRedirect,omitempty"`
/* An optional description of this resource. Provide this property when
you create the resource. */
// +optional
Description *string `json:"description,omitempty"`
/* Specifies changes to request and response headers that need to take effect for
the selected backendService. The headerAction specified here take effect after
headerAction specified under pathMatcher. */
// +optional
HeaderAction *UrlmapHeaderAction `json:"headerAction,omitempty"`
/* The list of HostRules to use against the URL. */
// +optional
HostRule []UrlmapHostRule `json:"hostRule,omitempty"`
/* Location represents the geographical location of the ComputeURLMap. Specify a region name or "global" for global resources. Reference: GCP definition of regions/zones (https://cloud.google.com/compute/docs/regions-zones/) */
Location string `json:"location"`
/* The list of named PathMatchers to use against the URL. */
// +optional
PathMatcher []UrlmapPathMatcher `json:"pathMatcher,omitempty"`
/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
// +optional
ResourceID *string `json:"resourceID,omitempty"`
/* The list of expected URL mappings. Requests to update this UrlMap will
succeed only if all of the test cases pass. */
// +optional
Test []UrlmapTest `json:"test,omitempty"`
}
type ComputeURLMapStatus struct {
/* Conditions represent the latest available observations of the
ComputeURLMap's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
/* Creation timestamp in RFC3339 text format. */
CreationTimestamp string `json:"creationTimestamp,omitempty"`
/* Fingerprint of this resource. This field is used internally during
updates of this resource. */
Fingerprint string `json:"fingerprint,omitempty"`
/* The unique identifier for the resource. */
MapId int `json:"mapId,omitempty"`
/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
ObservedGeneration int `json:"observedGeneration,omitempty"`
/* */
SelfLink string `json:"selfLink,omitempty"`
}
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ComputeURLMap is the Schema for the compute API
// +k8s:openapi-gen=true
type ComputeURLMap struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ComputeURLMapSpec `json:"spec,omitempty"`
Status ComputeURLMapStatus `json:"status,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ComputeURLMapList contains a list of ComputeURLMap
type ComputeURLMapList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ComputeURLMap `json:"items"`
}
func init() {
SchemeBuilder.Register(&ComputeURLMap{}, &ComputeURLMapList{})
}