summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/cloud/google/gcp_compute_url_map_info.py
blob: f1965b33c5b84f90417f8cbfb7a12becfbf7d238 (plain)
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
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017 Google
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# ----------------------------------------------------------------------------
#
#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
#
# ----------------------------------------------------------------------------
#
#     This file is automatically generated by Magic Modules and manual
#     changes will be clobbered when the file is regenerated.
#
#     Please read more about how to change this file at
#     https://www.github.com/GoogleCloudPlatform/magic-modules
#
# ----------------------------------------------------------------------------

from __future__ import absolute_import, division, print_function

__metaclass__ = type

################################################################################
# Documentation
################################################################################

ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}

DOCUMENTATION = '''
---
module: gcp_compute_url_map_info
description:
- Gather info for GCP UrlMap
short_description: Gather info for GCP UrlMap
version_added: '2.7'
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
options:
  filters:
    description:
    - A list of filter value pairs. Available filters are listed here U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).
    - Each additional filter in the list will act be added as an AND condition (filter1
      and filter2) .
    type: list
  project:
    description:
    - The Google Cloud Platform project to use.
    type: str
  auth_kind:
    description:
    - The type of credential used.
    type: str
    required: true
    choices:
    - application
    - machineaccount
    - serviceaccount
  service_account_contents:
    description:
    - The contents of a Service Account JSON file, either in a dictionary or as a
      JSON string that represents it.
    type: jsonarg
  service_account_file:
    description:
    - The path of a Service Account JSON file if serviceaccount is selected as type.
    type: path
  service_account_email:
    description:
    - An optional service account email address if machineaccount is selected and
      the user does not wish to use the default email.
    type: str
  scopes:
    description:
    - Array of scopes to be used
    type: list
  env_type:
    description:
    - Specifies which Ansible environment you're running this module within.
    - This should not be set unless you know what you're doing.
    - This only alters the User Agent string for any API requests.
    type: str
notes:
- for authentication, you can set service_account_file using the C(gcp_service_account_file)
  env variable.
- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS)
  env variable.
- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
  env variable.
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
- Environment variables values will only be used if the playbook values are not set.
- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
'''

EXAMPLES = '''
- name: get info on an URL map
  gcp_compute_url_map_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
'''

RETURN = '''
resources:
  description: List of resources
  returned: always
  type: complex
  contains:
    creationTimestamp:
      description:
      - Creation timestamp in RFC3339 text format.
      returned: success
      type: str
    defaultService:
      description:
      - The BackendService resource to which traffic is directed if none of the hostRules
        match. 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.
      returned: success
      type: dict
    description:
      description:
      - An optional description of this resource. Provide this property when you create
        the resource.
      returned: success
      type: str
    id:
      description:
      - The unique identifier for the resource.
      returned: success
      type: int
    fingerprint:
      description:
      - Fingerprint of this resource. A hash of the contents stored in this object.
        This field is used in optimistic locking.
      returned: success
      type: str
    headerAction:
      description:
      - 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.
      returned: success
      type: complex
      contains:
        requestHeadersToAdd:
          description:
          - Headers to add to a matching request prior to forwarding the request to
            the backendService.
          returned: success
          type: complex
          contains:
            headerName:
              description:
              - The name of the header.
              returned: success
              type: str
            headerValue:
              description:
              - The value of the header to add.
              returned: success
              type: str
            replace:
              description:
              - 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.
              returned: success
              type: bool
        requestHeadersToRemove:
          description:
          - A list of header names for headers that need to be removed from the request
            prior to forwarding the request to the backendService.
          returned: success
          type: list
        responseHeadersToAdd:
          description:
          - Headers to add the response prior to sending the response back to the
            client.
          returned: success
          type: complex
          contains:
            headerName:
              description:
              - The name of the header.
              returned: success
              type: str
            headerValue:
              description:
              - The value of the header to add.
              returned: success
              type: str
            replace:
              description:
              - 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.
              returned: success
              type: bool
        responseHeadersToRemove:
          description:
          - A list of header names for headers that need to be removed from the response
            prior to sending the response back to the client.
          returned: success
          type: list
    hostRules:
      description:
      - The list of HostRules to use against the URL.
      returned: success
      type: complex
      contains:
        description:
          description:
          - An optional description of this resource. Provide this property when you
            create the resource.
          returned: success
          type: str
        hosts:
          description:
          - 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 .
          returned: success
          type: list
        pathMatcher:
          description:
          - The name of the PathMatcher to use to match the path portion of the URL
            if the hostRule matches the URL's host portion.
          returned: success
          type: str
    name:
      description:
      - Name of the resource. Provided by the client when the resource is created.
        The name must be 1-63 characters long, and comply with RFC1035. Specifically,
        the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
        which means the first character must be a lowercase letter, and all following
        characters must be a dash, lowercase letter, or digit, except the last character,
        which cannot be a dash.
      returned: success
      type: str
    pathMatchers:
      description:
      - The list of named PathMatchers to use against the URL.
      returned: success
      type: complex
      contains:
        defaultService:
          description:
          - 'The BackendService resource. This will be used if none of the pathRules
            or routeRules defined by this PathMatcher are matched. For example, the
            following are all valid URLs to a BackendService resource: - U(https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backen)
            dService - compute/v1/projects/project/global/backendServices/backendService
            - global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices,
            defaultService must not be specified. Only one of defaultService, defaultUrlRedirect
            or defaultRouteAction.weightedBackendService must be set. Authorization
            requires one or more of the following Google IAM permissions on the specified
            resource default_service: - compute.backendBuckets.use - compute.backendServices.use
            .'
          returned: success
          type: dict
        description:
          description:
          - An optional description of this resource. Provide this property when you
            create the resource.
          returned: success
          type: str
        headerAction:
          description:
          - 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 .
          returned: success
          type: complex
          contains:
            requestHeadersToAdd:
              description:
              - Headers to add to a matching request prior to forwarding the request
                to the backendService.
              returned: success
              type: complex
              contains:
                headerName:
                  description:
                  - The name of the header.
                  returned: success
                  type: str
                headerValue:
                  description:
                  - The value of the header to add.
                  returned: success
                  type: str
                replace:
                  description:
                  - 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.
                  returned: success
                  type: bool
            requestHeadersToRemove:
              description:
              - A list of header names for headers that need to be removed from the
                request prior to forwarding the request to the backendService.
              returned: success
              type: list
            responseHeadersToAdd:
              description:
              - Headers to add the response prior to sending the response back to
                the client.
              returned: success
              type: complex
              contains:
                headerName:
                  description:
                  - The name of the header.
                  returned: success
                  type: str
                headerValue:
                  description:
                  - The value of the header to add.
                  returned: success
                  type: str
                replace:
                  description:
                  - 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.
                  returned: success
                  type: bool
            responseHeadersToRemove:
              description:
              - A list of header names for headers that need to be removed from the
                response prior to sending the response back to the client.
              returned: success
              type: list
        name:
          description:
          - The name to which this PathMatcher is referred by the HostRule.
          returned: success
          type: str
        pathRules:
          description:
          - '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.'
          returned: success
          type: complex
          contains:
            service:
              description:
              - The 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.
              returned: success
              type: dict
            paths:
              description:
              - '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.'
              returned: success
              type: list
            routeAction:
              description:
              - 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.
              returned: success
              type: complex
              contains:
                corsPolicy:
                  description:
                  - The specification for allowing client side cross-origin requests.
                    Please see W3C Recommendation for Cross Origin Resource Sharing
                    .
                  returned: success
                  type: complex
                  contains:
                    allowCredentials:
                      description:
                      - 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.
                      returned: success
                      type: bool
                    allowHeaders:
                      description:
                      - Specifies the content for the Access-Control-Allow-Headers
                        header.
                      returned: success
                      type: list
                    allowMethods:
                      description:
                      - Specifies the content for the Access-Control-Allow-Methods
                        header.
                      returned: success
                      type: list
                    allowOriginRegexes:
                      description:
                      - Specifies the regualar 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.
                      returned: success
                      type: list
                    allowOrigins:
                      description:
                      - 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.
                      returned: success
                      type: list
                    disabled:
                      description:
                      - If true, specifies the CORS policy is disabled.
                      returned: success
                      type: bool
                    exposeHeaders:
                      description:
                      - Specifies the content for the Access-Control-Expose-Headers
                        header.
                      returned: success
                      type: list
                    maxAge:
                      description:
                      - Specifies how long the results of a preflight request can
                        be cached. This translates to the content for the Access-Control-Max-Age
                        header.
                      returned: success
                      type: int
                faultInjectionPolicy:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    abort:
                      description:
                      - The specification for how client requests are aborted as part
                        of fault injection.
                      returned: success
                      type: complex
                      contains:
                        httpStatus:
                          description:
                          - The HTTP status code used to abort the request. The value
                            must be between 200 and 599 inclusive.
                          returned: success
                          type: int
                        percentage:
                          description:
                          - 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.
                          returned: success
                          type: str
                    delay:
                      description:
                      - The specification for how client requests are delayed as part
                        of fault injection, before being sent to a backend service.
                      returned: success
                      type: complex
                      contains:
                        fixedDelay:
                          description:
                          - Specifies the value of the fixed delay interval.
                          returned: success
                          type: complex
                          contains:
                            nanos:
                              description:
                              - 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.
                              returned: success
                              type: int
                            seconds:
                              description:
                              - Span of time at a resolution of a second. Must be
                                from 0 to 315,576,000,000 inclusive.
                              returned: success
                              type: str
                        percentage:
                          description:
                          - 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.
                          returned: success
                          type: str
                requestMirrorPolicy:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    backendService:
                      description:
                      - The BackendService resource being mirrored to.
                      returned: success
                      type: dict
                retryPolicy:
                  description:
                  - Specifies the retry policy associated with this route.
                  returned: success
                  type: complex
                  contains:
                    numRetries:
                      description:
                      - Specifies the allowed number retries. This number must be
                        > 0.
                      returned: success
                      type: int
                    perTryTimeout:
                      description:
                      - Specifies a non-zero timeout per retry attempt.
                      returned: success
                      type: complex
                      contains:
                        nanos:
                          description:
                          - 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.
                          returned: success
                          type: int
                        seconds:
                          description:
                          - Span of time at a resolution of a second. Must be from
                            0 to 315,576,000,000 inclusive.
                          returned: success
                          type: str
                    retryConditions:
                      description:
                      - '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 ."
                      returned: success
                      type: list
                timeout:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    nanos:
                      description:
                      - 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.
                      returned: success
                      type: int
                    seconds:
                      description:
                      - Span of time at a resolution of a second. Must be from 0 to
                        315,576,000,000 inclusive.
                      returned: success
                      type: str
                urlRewrite:
                  description:
                  - The spec to modify the URL of the request, prior to forwarding
                    the request to the matched service .
                  returned: success
                  type: complex
                  contains:
                    hostRewrite:
                      description:
                      - 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.
                      returned: success
                      type: str
                    pathPrefixRewrite:
                      description:
                      - 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.
                      returned: success
                      type: str
                weightedBackendServices:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    backendService:
                      description:
                      - The default BackendService resource. Before forwarding the
                        request to backendService, the loadbalancer applies any relevant
                        headerActions specified as part of this backendServiceWeight.
                      returned: success
                      type: dict
                    headerAction:
                      description:
                      - 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.
                      returned: success
                      type: complex
                      contains:
                        requestHeadersToAdd:
                          description:
                          - Headers to add to a matching request prior to forwarding
                            the request to the backendService.
                          returned: success
                          type: complex
                          contains:
                            headerName:
                              description:
                              - The name of the header.
                              returned: success
                              type: str
                            headerValue:
                              description:
                              - The value of the header to add.
                              returned: success
                              type: str
                            replace:
                              description:
                              - 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.
                              returned: success
                              type: bool
                        requestHeadersToRemove:
                          description:
                          - A list of header names for headers that need to be removed
                            from the request prior to forwarding the request to the
                            backendService.
                          returned: success
                          type: list
                        responseHeadersToAdd:
                          description:
                          - Headers to add the response prior to sending the response
                            back to the client.
                          returned: success
                          type: complex
                          contains:
                            headerName:
                              description:
                              - The name of the header.
                              returned: success
                              type: str
                            headerValue:
                              description:
                              - The value of the header to add.
                              returned: success
                              type: str
                            replace:
                              description:
                              - 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.
                              returned: success
                              type: bool
                        responseHeadersToRemove:
                          description:
                          - A list of header names for headers that need to be removed
                            from the response prior to sending the response back to
                            the client.
                          returned: success
                          type: list
                    weight:
                      description:
                      - 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 .
                      returned: success
                      type: int
            urlRedirect:
              description:
              - 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.
              returned: success
              type: complex
              contains:
                hostRedirect:
                  description:
                  - 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.
                  returned: success
                  type: str
                httpsRedirect:
                  description:
                  - 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. Defaults
                    to false.
                  returned: success
                  type: bool
                pathRedirect:
                  description:
                  - The path that will be used in the redirect response instead of
                    the one that was supplied in the request. Only one of pathRedirect
                    or prefixRedirect must be specified. The value must be between
                    1 and 1024 characters.
                  returned: success
                  type: str
                prefixRedirect:
                  description:
                  - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
                    retaining the remaining portion of the URL before redirecting
                    the request.
                  returned: success
                  type: str
                redirectResponseCode:
                  description:
                  - '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."
                  returned: success
                  type: str
                stripQuery:
                  description:
                  - 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.
                  returned: success
                  type: bool
        routeRules:
          description:
          - '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.'
          returned: success
          type: complex
          contains:
            priority:
              description:
              - 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.
              returned: success
              type: int
            service:
              description:
              - The 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.
              returned: success
              type: dict
            headerAction:
              description:
              - 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
                .
              returned: success
              type: complex
              contains:
                requestHeadersToAdd:
                  description:
                  - Headers to add to a matching request prior to forwarding the request
                    to the backendService.
                  returned: success
                  type: complex
                  contains:
                    headerName:
                      description:
                      - The name of the header.
                      returned: success
                      type: str
                    headerValue:
                      description:
                      - The value of the header to add.
                      returned: success
                      type: str
                    replace:
                      description:
                      - 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.
                      returned: success
                      type: bool
                requestHeadersToRemove:
                  description:
                  - A list of header names for headers that need to be removed from
                    the request prior to forwarding the request to the backendService.
                  returned: success
                  type: list
                responseHeadersToAdd:
                  description:
                  - Headers to add the response prior to sending the response back
                    to the client.
                  returned: success
                  type: complex
                  contains:
                    headerName:
                      description:
                      - The name of the header.
                      returned: success
                      type: str
                    headerValue:
                      description:
                      - The value of the header to add.
                      returned: success
                      type: str
                    replace:
                      description:
                      - 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.
                      returned: success
                      type: bool
                responseHeadersToRemove:
                  description:
                  - A list of header names for headers that need to be removed from
                    the response prior to sending the response back to the client.
                  returned: success
                  type: list
            matchRules:
              description:
              - The rules for determining a match.
              returned: success
              type: complex
              contains:
                fullPathMatch:
                  description:
                  - For satifying 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.
                  returned: success
                  type: str
                headerMatches:
                  description:
                  - Specifies a list of header match criteria, all of which must match
                    corresponding headers in the request.
                  returned: success
                  type: complex
                  contains:
                    exactMatch:
                      description:
                      - The value should exactly match contents of exactMatch. Only
                        one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch
                        or rangeMatch must be set.
                      returned: success
                      type: str
                    headerName:
                      description:
                      - 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".
                      returned: success
                      type: str
                    invertMatch:
                      description:
                      - 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.
                      returned: success
                      type: bool
                    prefixMatch:
                      description:
                      - 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.
                      returned: success
                      type: str
                    presentMatch:
                      description:
                      - 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.
                      returned: success
                      type: bool
                    rangeMatch:
                      description:
                      - 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.
                      returned: success
                      type: complex
                      contains:
                        rangeEnd:
                          description:
                          - The end of the range (exclusive).
                          returned: success
                          type: int
                        rangeStart:
                          description:
                          - The start of the range (inclusive).
                          returned: success
                          type: int
                    regexMatch:
                      description:
                      - 'The value of the header must match the regualar 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.
                      returned: success
                      type: str
                    suffixMatch:
                      description:
                      - 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.
                      returned: success
                      type: str
                ignoreCase:
                  description:
                  - Specifies that prefixMatch and fullPathMatch matches are case
                    sensitive.
                  - Defaults to false.
                  returned: success
                  type: bool
                metadataFilters:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    filterLabels:
                      description:
                      - 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.
                      returned: success
                      type: complex
                      contains:
                        name:
                          description:
                          - Name of metadata label. The name can have a maximum length
                            of 1024 characters and must be at least 1 character long.
                          returned: success
                          type: str
                        value:
                          description:
                          - The value of the label must match the specified value.
                            value can have a maximum length of 1024 characters.
                          returned: success
                          type: str
                    filterMatchCriteria:
                      description:
                      - '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."
                      returned: success
                      type: str
                prefixMatch:
                  description:
                  - For satifying 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.
                  returned: success
                  type: str
                queryParameterMatches:
                  description:
                  - Specifies a list of query parameter match criteria, all of which
                    must match corresponding query parameters in the request.
                  returned: success
                  type: complex
                  contains:
                    exactMatch:
                      description:
                      - 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.
                      returned: success
                      type: str
                    name:
                      description:
                      - 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.
                      returned: success
                      type: str
                    presentMatch:
                      description:
                      - 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.
                      returned: success
                      type: bool
                    regexMatch:
                      description:
                      - 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.
                      returned: success
                      type: str
                regexMatch:
                  description:
                  - For satifying 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.
                  returned: success
                  type: str
            routeAction:
              description:
              - 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.
              returned: success
              type: complex
              contains:
                corsPolicy:
                  description:
                  - The specification for allowing client side cross-origin requests.
                    Please see W3C Recommendation for Cross Origin Resource Sharing
                    .
                  returned: success
                  type: complex
                  contains:
                    allowCredentials:
                      description:
                      - 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.
                      returned: success
                      type: bool
                    allowHeaders:
                      description:
                      - Specifies the content for the Access-Control-Allow-Headers
                        header.
                      returned: success
                      type: list
                    allowMethods:
                      description:
                      - Specifies the content for the Access-Control-Allow-Methods
                        header.
                      returned: success
                      type: list
                    allowOriginRegexes:
                      description:
                      - Specifies the regualar 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.
                      returned: success
                      type: list
                    allowOrigins:
                      description:
                      - 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.
                      returned: success
                      type: list
                    disabled:
                      description:
                      - If true, specifies the CORS policy is disabled.
                      - which indicates that the CORS policy is in effect. Defaults
                        to false.
                      returned: success
                      type: bool
                    exposeHeaders:
                      description:
                      - Specifies the content for the Access-Control-Expose-Headers
                        header.
                      returned: success
                      type: list
                    maxAge:
                      description:
                      - Specifies how long the results of a preflight request can
                        be cached. This translates to the content for the Access-Control-Max-Age
                        header.
                      returned: success
                      type: int
                faultInjectionPolicy:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    abort:
                      description:
                      - The specification for how client requests are aborted as part
                        of fault injection.
                      returned: success
                      type: complex
                      contains:
                        httpStatus:
                          description:
                          - The HTTP status code used to abort the request. The value
                            must be between 200 and 599 inclusive.
                          returned: success
                          type: int
                        percentage:
                          description:
                          - 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.
                          returned: success
                          type: str
                    delay:
                      description:
                      - The specification for how client requests are delayed as part
                        of fault injection, before being sent to a backend service.
                      returned: success
                      type: complex
                      contains:
                        fixedDelay:
                          description:
                          - Specifies the value of the fixed delay interval.
                          returned: success
                          type: complex
                          contains:
                            nanos:
                              description:
                              - 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.
                              returned: success
                              type: int
                            seconds:
                              description:
                              - Span of time at a resolution of a second. Must be
                                from 0 to 315,576,000,000 inclusive.
                              returned: success
                              type: str
                        percentage:
                          description:
                          - 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.
                          returned: success
                          type: str
                requestMirrorPolicy:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    backendService:
                      description:
                      - The BackendService resource being mirrored to.
                      returned: success
                      type: dict
                retryPolicy:
                  description:
                  - Specifies the retry policy associated with this route.
                  returned: success
                  type: complex
                  contains:
                    numRetries:
                      description:
                      - Specifies the allowed number retries. This number must be
                        > 0.
                      returned: success
                      type: int
                    perTryTimeout:
                      description:
                      - Specifies a non-zero timeout per retry attempt.
                      - If not specified, will use the timeout set in HttpRouteAction.
                        If timeout in HttpRouteAction is not set, will use the largest
                        timeout among all backend services associated with the route.
                      returned: success
                      type: complex
                      contains:
                        nanos:
                          description:
                          - 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.
                          returned: success
                          type: int
                        seconds:
                          description:
                          - Span of time at a resolution of a second. Must be from
                            0 to 315,576,000,000 inclusive.
                          returned: success
                          type: str
                    retryConditions:
                      description:
                      - 'Specfies 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 ."
                      returned: success
                      type: list
                timeout:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    nanos:
                      description:
                      - 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.
                      returned: success
                      type: int
                    seconds:
                      description:
                      - Span of time at a resolution of a second. Must be from 0 to
                        315,576,000,000 inclusive.
                      returned: success
                      type: str
                urlRewrite:
                  description:
                  - The spec to modify the URL of the request, prior to forwarding
                    the request to the matched service .
                  returned: success
                  type: complex
                  contains:
                    hostRewrite:
                      description:
                      - 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.
                      returned: success
                      type: str
                    pathPrefixRewrite:
                      description:
                      - 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.
                      returned: success
                      type: str
                weightedBackendServices:
                  description:
                  - 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.
                  returned: success
                  type: complex
                  contains:
                    backendService:
                      description:
                      - The default BackendService resource. Before forwarding the
                        request to backendService, the loadbalancer applies any relevant
                        headerActions specified as part of this backendServiceWeight.
                      returned: success
                      type: dict
                    headerAction:
                      description:
                      - 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.
                      returned: success
                      type: complex
                      contains:
                        requestHeadersToAdd:
                          description:
                          - Headers to add to a matching request prior to forwarding
                            the request to the backendService.
                          returned: success
                          type: complex
                          contains:
                            headerName:
                              description:
                              - The name of the header.
                              returned: success
                              type: str
                            headerValue:
                              description:
                              - The value of the header to add.
                              returned: success
                              type: str
                            replace:
                              description:
                              - 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.
                              returned: success
                              type: bool
                        requestHeadersToRemove:
                          description:
                          - A list of header names for headers that need to be removed
                            from the request prior to forwarding the request to the
                            backendService.
                          returned: success
                          type: list
                        responseHeadersToAdd:
                          description:
                          - Headers to add the response prior to sending the response
                            back to the client.
                          returned: success
                          type: complex
                          contains:
                            headerName:
                              description:
                              - The name of the header.
                              returned: success
                              type: str
                            headerValue:
                              description:
                              - The value of the header to add.
                              returned: success
                              type: str
                            replace:
                              description:
                              - 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.
                              returned: success
                              type: bool
                        responseHeadersToRemove:
                          description:
                          - A list of header names for headers that need to be removed
                            from the response prior to sending the response back to
                            the client.
                          returned: success
                          type: list
                    weight:
                      description:
                      - 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 .
                      returned: success
                      type: int
            urlRedirect:
              description:
              - 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.
              returned: success
              type: complex
              contains:
                hostRedirect:
                  description:
                  - 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.
                  returned: success
                  type: str
                httpsRedirect:
                  description:
                  - 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. Defaults
                    to false.
                  returned: success
                  type: bool
                pathRedirect:
                  description:
                  - The path that will be used in the redirect response instead of
                    the one that was supplied in the request. Only one of pathRedirect
                    or prefixRedirect must be specified. The value must be between
                    1 and 1024 characters.
                  returned: success
                  type: str
                prefixRedirect:
                  description:
                  - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
                    retaining the remaining portion of the URL before redirecting
                    the request.
                  returned: success
                  type: str
                redirectResponseCode:
                  description:
                  - '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.'
                  returned: success
                  type: str
                stripQuery:
                  description:
                  - 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. Defaults to
                    false.
                  returned: success
                  type: bool
    tests:
      description:
      - The list of expected URL mapping tests. Request to update this UrlMap will
        succeed only if all of the test cases pass. You can specify a maximum of 100
        tests per UrlMap.
      returned: success
      type: complex
      contains:
        description:
          description:
          - Description of this test case.
          returned: success
          type: str
        host:
          description:
          - Host portion of the URL.
          returned: success
          type: str
        path:
          description:
          - Path portion of the URL.
          returned: success
          type: str
        service:
          description:
          - Expected BackendService resource the given URL should be mapped to.
          returned: success
          type: dict
'''

################################################################################
# Imports
################################################################################
from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
import json

################################################################################
# Main
################################################################################


def main():
    module = GcpModule(argument_spec=dict(filters=dict(type='list', elements='str')))

    if not module.params['scopes']:
        module.params['scopes'] = ['https://www.googleapis.com/auth/compute']

    return_value = {'resources': fetch_list(module, collection(module), query_options(module.params['filters']))}
    module.exit_json(**return_value)


def collection(module):
    return "https://www.googleapis.com/compute/v1/projects/{project}/global/urlMaps".format(**module.params)


def fetch_list(module, link, query):
    auth = GcpSession(module, 'compute')
    return auth.list(link, return_if_object, array_name='items', params={'filter': query})


def query_options(filters):
    if not filters:
        return ''

    if len(filters) == 1:
        return filters[0]
    else:
        queries = []
        for f in filters:
            # For multiple queries, all queries should have ()
            if f[0] != '(' and f[-1] != ')':
                queries.append("(%s)" % ''.join(f))
            else:
                queries.append(f)

        return ' '.join(queries)


def return_if_object(module, response):
    # If not found, return nothing.
    if response.status_code == 404:
        return None

    # If no content, return nothing.
    if response.status_code == 204:
        return None

    try:
        module.raise_for_status(response)
        result = response.json()
    except getattr(json.decoder, 'JSONDecodeError', ValueError) as inst:
        module.fail_json(msg="Invalid JSON response with error: %s" % inst)

    if navigate_hash(result, ['error', 'errors']):
        module.fail_json(msg=navigate_hash(result, ['error', 'errors']))

    return result


if __name__ == "__main__":
    main()