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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.managedZones.html">managedZones</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new ManagedZone.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a previously created ManagedZone.</p>
<p class="toc_element">
<code><a href="#get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches the representation of an existing ManagedZone.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(project, dnsName=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enumerates ManagedZones that have been created but not yet deleted.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Applies a partial update to an existing ManagedZone.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this returns an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<p class="toc_element">
<code><a href="#update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing ManagedZone.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Creates a new ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
body: object, The request body.
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</code>
<pre>Deletes a previously created ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</code>
<pre>Fetches the representation of an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
"requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, dnsName=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Enumerates ManagedZones that have been created but not yet deleted.
Args:
project: string, Identifies the project addressed by this request. (required)
dnsName: string, Restricts the list to return only zones with this domain name.
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "dns#managedZonesListResponse", # Type of resource.
"managedZones": [ # The managed zone resources.
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
],
"nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Applies a partial update to an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
body: object, The request body.
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
},
"id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
"kind": "dns#operation",
"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
"user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
"newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
"oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this returns an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Updates an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
body: object, The request body.
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
},
"id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
"kind": "dns#operation",
"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
"user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
"newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
"oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"domainName": "A String", # Fully qualified domain name for the forwarding target.
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
},
}</pre>
</div>
</body></html>
|