| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.managedZones.html">managedZones</a></h1> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a new ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 84 | <code><a href="#delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 85 | <p class="firstline">Deletes a previously created ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 88 | <p class="firstline">Fetches the representation of an existing ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(project, dnsName=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 91 | <p class="firstline">Enumerates ManagedZones that have been created but not yet deleted.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 97 | <p class="firstline">Applies a partial update to an existing ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <code><a href="#update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 100 | <p class="firstline">Updates an existing ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <code class="details" id="close">close()</code> |
| 104 | <pre>Close httplib2 connections.</pre> |
| 105 | </div> |
| 106 | |
| 107 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 109 | <pre>Creates a new ManagedZone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | |
| 111 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 112 | project: string, Identifies the project addressed by this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 113 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 114 | The object takes the form of: |
| 115 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 116 | { # 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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 117 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 118 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 119 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 120 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 121 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 122 | "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. |
| 123 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 124 | "dnssecConfig": { # DNSSEC configuration. |
| 125 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 126 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 127 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 128 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 129 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 130 | "kind": "dns#dnsKeySpec", |
| 131 | }, |
| 132 | ], |
| 133 | "kind": "dns#managedZoneDnsSecConfig", |
| 134 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 135 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 136 | }, |
| 137 | "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. |
| 138 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 139 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 140 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 141 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 142 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 143 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 144 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 145 | }, |
| 146 | ], |
| 147 | }, |
| 148 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 149 | "kind": "dns#managedZone", |
| 150 | "labels": { # User labels. |
| 151 | "a_key": "A String", |
| 152 | }, |
| 153 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 154 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 155 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 156 | "A String", |
| 157 | ], |
| 158 | "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. |
| 159 | "kind": "dns#managedZonePeeringConfig", |
| 160 | "targetNetwork": { # The network with which to peer. |
| 161 | "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. |
| 162 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 163 | "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} |
| 164 | }, |
| 165 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 166 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 167 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 168 | { |
| 169 | "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 |
| 170 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 171 | }, |
| 172 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 173 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 174 | "networks": [ # The list of VPC networks that can see this zone. |
| 175 | { |
| 176 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 177 | "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} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 178 | }, |
| 179 | ], |
| 180 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 181 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 182 | "kind": "dns#managedZoneReverseLookupConfig", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 183 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 184 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 185 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 186 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 187 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 188 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 189 | "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} |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 190 | }, |
| 191 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 192 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 193 | } |
| 194 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 195 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 196 | x__xgafv: string, V1 error format. |
| 197 | Allowed values |
| 198 | 1 - v1 error format |
| 199 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 200 | |
| 201 | Returns: |
| 202 | An object of the form: |
| 203 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 204 | { # 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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 205 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 206 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 207 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 208 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 209 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 210 | "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. |
| 211 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 212 | "dnssecConfig": { # DNSSEC configuration. |
| 213 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 214 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 215 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 216 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 217 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 218 | "kind": "dns#dnsKeySpec", |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 219 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 220 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 221 | "kind": "dns#managedZoneDnsSecConfig", |
| 222 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 223 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 224 | }, |
| 225 | "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. |
| 226 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 227 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 228 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 229 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 230 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 231 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 232 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 233 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 234 | ], |
| 235 | }, |
| 236 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 237 | "kind": "dns#managedZone", |
| 238 | "labels": { # User labels. |
| 239 | "a_key": "A String", |
| 240 | }, |
| 241 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 242 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 243 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 244 | "A String", |
| 245 | ], |
| 246 | "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. |
| 247 | "kind": "dns#managedZonePeeringConfig", |
| 248 | "targetNetwork": { # The network with which to peer. |
| 249 | "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. |
| 250 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 251 | "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} |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 252 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 253 | }, |
| 254 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 255 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 256 | { |
| 257 | "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 |
| 258 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 259 | }, |
| 260 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 261 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 262 | "networks": [ # The list of VPC networks that can see this zone. |
| 263 | { |
| 264 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 265 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 266 | }, |
| 267 | ], |
| 268 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 269 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 270 | "kind": "dns#managedZoneReverseLookupConfig", |
| 271 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 272 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 273 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 274 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 275 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 276 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 277 | "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} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 278 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 279 | }, |
| 280 | "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. |
| 281 | }</pre> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 282 | </div> |
| 283 | |
| 284 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 285 | <code class="details" id="delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 286 | <pre>Deletes a previously created ManagedZone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 287 | |
| 288 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 289 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 290 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 291 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 292 | x__xgafv: string, V1 error format. |
| 293 | Allowed values |
| 294 | 1 - v1 error format |
| 295 | 2 - v2 error format |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 296 | </pre> |
| 297 | </div> |
| 298 | |
| 299 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 300 | <code class="details" id="get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 301 | <pre>Fetches the representation of an existing ManagedZone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 302 | |
| 303 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 304 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 305 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 306 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 307 | x__xgafv: string, V1 error format. |
| 308 | Allowed values |
| 309 | 1 - v1 error format |
| 310 | 2 - v2 error format |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 311 | |
| 312 | Returns: |
| 313 | An object of the form: |
| 314 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 315 | { # 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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 316 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 317 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 318 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 319 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 320 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 321 | "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. |
| 322 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 323 | "dnssecConfig": { # DNSSEC configuration. |
| 324 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 325 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 326 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 327 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 328 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 329 | "kind": "dns#dnsKeySpec", |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 330 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 331 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 332 | "kind": "dns#managedZoneDnsSecConfig", |
| 333 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 334 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 335 | }, |
| 336 | "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. |
| 337 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 338 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 339 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 340 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 341 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 342 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 343 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 344 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 345 | ], |
| 346 | }, |
| 347 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 348 | "kind": "dns#managedZone", |
| 349 | "labels": { # User labels. |
| 350 | "a_key": "A String", |
| 351 | }, |
| 352 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 353 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 354 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 355 | "A String", |
| 356 | ], |
| 357 | "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. |
| 358 | "kind": "dns#managedZonePeeringConfig", |
| 359 | "targetNetwork": { # The network with which to peer. |
| 360 | "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. |
| 361 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 362 | "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} |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 363 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 364 | }, |
| 365 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 366 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 367 | { |
| 368 | "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 |
| 369 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 370 | }, |
| 371 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 372 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 373 | "networks": [ # The list of VPC networks that can see this zone. |
| 374 | { |
| 375 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 376 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 377 | }, |
| 378 | ], |
| 379 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 380 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 381 | "kind": "dns#managedZoneReverseLookupConfig", |
| 382 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 383 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 384 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 385 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 386 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 387 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 388 | "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} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 389 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 390 | }, |
| 391 | "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. |
| 392 | }</pre> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 393 | </div> |
| 394 | |
| 395 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 396 | <code class="details" id="list">list(project, dnsName=None, maxResults=None, pageToken=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 397 | <pre>Enumerates ManagedZones that have been created but not yet deleted. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 398 | |
| 399 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 400 | project: string, Identifies the project addressed by this request. (required) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 401 | dnsName: string, Restricts the list to return only zones with this domain name. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 402 | maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 403 | pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 404 | x__xgafv: string, V1 error format. |
| 405 | Allowed values |
| 406 | 1 - v1 error format |
| 407 | 2 - v2 error format |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 408 | |
| 409 | Returns: |
| 410 | An object of the form: |
| 411 | |
| 412 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 413 | "header": { # Elements common to every response. |
| 414 | "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). |
| 415 | }, |
| 416 | "kind": "dns#managedZonesListResponse", # Type of resource. |
| 417 | "managedZones": [ # The managed zone resources. |
| 418 | { # 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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 419 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 420 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 421 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 422 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 423 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 424 | "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. |
| 425 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 426 | "dnssecConfig": { # DNSSEC configuration. |
| 427 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 428 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 429 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 430 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 431 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 432 | "kind": "dns#dnsKeySpec", |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 433 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 434 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 435 | "kind": "dns#managedZoneDnsSecConfig", |
| 436 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 437 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 438 | }, |
| 439 | "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. |
| 440 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 441 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 442 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 443 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 444 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 445 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 446 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 447 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 448 | ], |
| 449 | }, |
| 450 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 451 | "kind": "dns#managedZone", |
| 452 | "labels": { # User labels. |
| 453 | "a_key": "A String", |
| 454 | }, |
| 455 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 456 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 457 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 458 | "A String", |
| 459 | ], |
| 460 | "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. |
| 461 | "kind": "dns#managedZonePeeringConfig", |
| 462 | "targetNetwork": { # The network with which to peer. |
| 463 | "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. |
| 464 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 465 | "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} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 466 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 467 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 468 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 469 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 470 | { |
| 471 | "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 |
| 472 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 473 | }, |
| 474 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 475 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 476 | "networks": [ # The list of VPC networks that can see this zone. |
| 477 | { |
| 478 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 479 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 480 | }, |
| 481 | ], |
| 482 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 483 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 484 | "kind": "dns#managedZoneReverseLookupConfig", |
| 485 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 486 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 487 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 488 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 489 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 490 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 491 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 492 | }, |
| 493 | }, |
| 494 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 495 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 496 | ], |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 497 | "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections 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 cannot retrieve a consistent snapshot of a collection larger than the maximum page size. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 498 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 499 | </div> |
| 500 | |
| 501 | <div class="method"> |
| 502 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 503 | <pre>Retrieves the next page of results. |
| 504 | |
| 505 | Args: |
| 506 | previous_request: The request for the previous page. (required) |
| 507 | previous_response: The response from the request for the previous page. (required) |
| 508 | |
| 509 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 510 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 511 | page. Returns None if there are no more items in the collection. |
| 512 | </pre> |
| 513 | </div> |
| 514 | |
| 515 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 516 | <code class="details" id="patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 517 | <pre>Applies a partial update to an existing ManagedZone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 518 | |
| 519 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 520 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 521 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 522 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 523 | The object takes the form of: |
| 524 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 525 | { # 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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 526 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 527 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 528 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 529 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 530 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 531 | "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. |
| 532 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 533 | "dnssecConfig": { # DNSSEC configuration. |
| 534 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 535 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 536 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 537 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 538 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 539 | "kind": "dns#dnsKeySpec", |
| 540 | }, |
| 541 | ], |
| 542 | "kind": "dns#managedZoneDnsSecConfig", |
| 543 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 544 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 545 | }, |
| 546 | "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. |
| 547 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 548 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 549 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 550 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 551 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 552 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 553 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 554 | }, |
| 555 | ], |
| 556 | }, |
| 557 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 558 | "kind": "dns#managedZone", |
| 559 | "labels": { # User labels. |
| 560 | "a_key": "A String", |
| 561 | }, |
| 562 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 563 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 564 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 565 | "A String", |
| 566 | ], |
| 567 | "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. |
| 568 | "kind": "dns#managedZonePeeringConfig", |
| 569 | "targetNetwork": { # The network with which to peer. |
| 570 | "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. |
| 571 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 572 | "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} |
| 573 | }, |
| 574 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 575 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 576 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 577 | { |
| 578 | "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 |
| 579 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 580 | }, |
| 581 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 582 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 583 | "networks": [ # The list of VPC networks that can see this zone. |
| 584 | { |
| 585 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 586 | "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} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 587 | }, |
| 588 | ], |
| 589 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 590 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 591 | "kind": "dns#managedZoneReverseLookupConfig", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 592 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 593 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 594 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 595 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 596 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 597 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 598 | "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} |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 599 | }, |
| 600 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 601 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 602 | } |
| 603 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 604 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 605 | x__xgafv: string, V1 error format. |
| 606 | Allowed values |
| 607 | 1 - v1 error format |
| 608 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 609 | |
| 610 | Returns: |
| 611 | An object of the form: |
| 612 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 613 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 614 | "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). |
| 615 | "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. |
| 616 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 617 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 618 | "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. |
| 619 | "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. |
| 620 | { |
| 621 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 622 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 623 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 624 | ], |
| 625 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 626 | "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. |
| 627 | "keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 628 | "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. |
| 629 | "kind": "dns#dnsKey", |
| 630 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 631 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 632 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 633 | "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. |
| 634 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 635 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 636 | "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. |
| 637 | "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. |
| 638 | { |
| 639 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 640 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| 641 | }, |
| 642 | ], |
| 643 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 644 | "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. |
| 645 | "keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 646 | "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. |
| 647 | "kind": "dns#dnsKey", |
| 648 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 649 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 650 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 651 | }, |
| 652 | "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) |
| 653 | "kind": "dns#operation", |
| 654 | "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only). |
| 655 | "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. |
| 656 | "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only). |
| 657 | "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) |
| 658 | "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). |
| 659 | "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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 660 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 661 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 662 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 663 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 664 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 665 | "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. |
| 666 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 667 | "dnssecConfig": { # DNSSEC configuration. |
| 668 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 669 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 670 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 671 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 672 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 673 | "kind": "dns#dnsKeySpec", |
| 674 | }, |
| 675 | ], |
| 676 | "kind": "dns#managedZoneDnsSecConfig", |
| 677 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 678 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 679 | }, |
| 680 | "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. |
| 681 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 682 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 683 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 684 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 685 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 686 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 687 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 688 | }, |
| 689 | ], |
| 690 | }, |
| 691 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 692 | "kind": "dns#managedZone", |
| 693 | "labels": { # User labels. |
| 694 | "a_key": "A String", |
| 695 | }, |
| 696 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 697 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 698 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 699 | "A String", |
| 700 | ], |
| 701 | "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. |
| 702 | "kind": "dns#managedZonePeeringConfig", |
| 703 | "targetNetwork": { # The network with which to peer. |
| 704 | "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. |
| 705 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 706 | "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} |
| 707 | }, |
| 708 | }, |
| 709 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 710 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 711 | { |
| 712 | "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 |
| 713 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 714 | }, |
| 715 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 716 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 717 | "networks": [ # The list of VPC networks that can see this zone. |
| 718 | { |
| 719 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 720 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 721 | }, |
| 722 | ], |
| 723 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 724 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 725 | "kind": "dns#managedZoneReverseLookupConfig", |
| 726 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 727 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 728 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 729 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 730 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 731 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 732 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 733 | }, |
| 734 | }, |
| 735 | "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. |
| 736 | }, |
| 737 | "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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 738 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 739 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 740 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 741 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 742 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 743 | "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. |
| 744 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 745 | "dnssecConfig": { # DNSSEC configuration. |
| 746 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 747 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 748 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 749 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 750 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 751 | "kind": "dns#dnsKeySpec", |
| 752 | }, |
| 753 | ], |
| 754 | "kind": "dns#managedZoneDnsSecConfig", |
| 755 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 756 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 757 | }, |
| 758 | "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. |
| 759 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 760 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 761 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 762 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 763 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 764 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 765 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 766 | }, |
| 767 | ], |
| 768 | }, |
| 769 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 770 | "kind": "dns#managedZone", |
| 771 | "labels": { # User labels. |
| 772 | "a_key": "A String", |
| 773 | }, |
| 774 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 775 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 776 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 777 | "A String", |
| 778 | ], |
| 779 | "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. |
| 780 | "kind": "dns#managedZonePeeringConfig", |
| 781 | "targetNetwork": { # The network with which to peer. |
| 782 | "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. |
| 783 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 784 | "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} |
| 785 | }, |
| 786 | }, |
| 787 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 788 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 789 | { |
| 790 | "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 |
| 791 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 792 | }, |
| 793 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 794 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 795 | "networks": [ # The list of VPC networks that can see this zone. |
| 796 | { |
| 797 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 798 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 799 | }, |
| 800 | ], |
| 801 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 802 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 803 | "kind": "dns#managedZoneReverseLookupConfig", |
| 804 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 805 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 806 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 807 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 808 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 809 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 810 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 811 | }, |
| 812 | }, |
| 813 | "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. |
| 814 | }, |
| 815 | }, |
| 816 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 817 | </div> |
| 818 | |
| 819 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 820 | <code class="details" id="update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 821 | <pre>Updates an existing ManagedZone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 822 | |
| 823 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 824 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 825 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 826 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 827 | The object takes the form of: |
| 828 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 829 | { # 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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 830 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 831 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 832 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 833 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 834 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 835 | "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. |
| 836 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 837 | "dnssecConfig": { # DNSSEC configuration. |
| 838 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 839 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 840 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 841 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 842 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 843 | "kind": "dns#dnsKeySpec", |
| 844 | }, |
| 845 | ], |
| 846 | "kind": "dns#managedZoneDnsSecConfig", |
| 847 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 848 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 849 | }, |
| 850 | "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. |
| 851 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 852 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 853 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 854 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 855 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 856 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 857 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 858 | }, |
| 859 | ], |
| 860 | }, |
| 861 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 862 | "kind": "dns#managedZone", |
| 863 | "labels": { # User labels. |
| 864 | "a_key": "A String", |
| 865 | }, |
| 866 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 867 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 868 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 869 | "A String", |
| 870 | ], |
| 871 | "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. |
| 872 | "kind": "dns#managedZonePeeringConfig", |
| 873 | "targetNetwork": { # The network with which to peer. |
| 874 | "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. |
| 875 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 876 | "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} |
| 877 | }, |
| 878 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 879 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 880 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 881 | { |
| 882 | "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 |
| 883 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 884 | }, |
| 885 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 886 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 887 | "networks": [ # The list of VPC networks that can see this zone. |
| 888 | { |
| 889 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 890 | "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} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 891 | }, |
| 892 | ], |
| 893 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 894 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 895 | "kind": "dns#managedZoneReverseLookupConfig", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 896 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 897 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 898 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 899 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 900 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 901 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 902 | "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} |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 903 | }, |
| 904 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 905 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 906 | } |
| 907 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 908 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 909 | x__xgafv: string, V1 error format. |
| 910 | Allowed values |
| 911 | 1 - v1 error format |
| 912 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 913 | |
| 914 | Returns: |
| 915 | An object of the form: |
| 916 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 917 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 918 | "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). |
| 919 | "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. |
| 920 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 921 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 922 | "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. |
| 923 | "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. |
| 924 | { |
| 925 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 926 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 927 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 928 | ], |
| 929 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 930 | "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. |
| 931 | "keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 932 | "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. |
| 933 | "kind": "dns#dnsKey", |
| 934 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 935 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 936 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 937 | "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. |
| 938 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 939 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 940 | "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. |
| 941 | "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. |
| 942 | { |
| 943 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 944 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| 945 | }, |
| 946 | ], |
| 947 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 948 | "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. |
| 949 | "keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 950 | "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. |
| 951 | "kind": "dns#dnsKey", |
| 952 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 953 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 954 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 955 | }, |
| 956 | "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) |
| 957 | "kind": "dns#operation", |
| 958 | "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only). |
| 959 | "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. |
| 960 | "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only). |
| 961 | "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) |
| 962 | "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). |
| 963 | "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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 964 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 965 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 966 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 967 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 968 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 969 | "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. |
| 970 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 971 | "dnssecConfig": { # DNSSEC configuration. |
| 972 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 973 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 974 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 975 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 976 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 977 | "kind": "dns#dnsKeySpec", |
| 978 | }, |
| 979 | ], |
| 980 | "kind": "dns#managedZoneDnsSecConfig", |
| 981 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 982 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 983 | }, |
| 984 | "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. |
| 985 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 986 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 987 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 988 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 989 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 990 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 991 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 992 | }, |
| 993 | ], |
| 994 | }, |
| 995 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 996 | "kind": "dns#managedZone", |
| 997 | "labels": { # User labels. |
| 998 | "a_key": "A String", |
| 999 | }, |
| 1000 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1001 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1002 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 1003 | "A String", |
| 1004 | ], |
| 1005 | "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. |
| 1006 | "kind": "dns#managedZonePeeringConfig", |
| 1007 | "targetNetwork": { # The network with which to peer. |
| 1008 | "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. |
| 1009 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 1010 | "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} |
| 1011 | }, |
| 1012 | }, |
| 1013 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 1014 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 1015 | { |
| 1016 | "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 |
| 1017 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 1018 | }, |
| 1019 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1020 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 1021 | "networks": [ # The list of VPC networks that can see this zone. |
| 1022 | { |
| 1023 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1024 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1025 | }, |
| 1026 | ], |
| 1027 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1028 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1029 | "kind": "dns#managedZoneReverseLookupConfig", |
| 1030 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1031 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1032 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 1033 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1034 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1035 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1036 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1037 | }, |
| 1038 | }, |
| 1039 | "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. |
| 1040 | }, |
| 1041 | "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. |
| yoshi-code-bot | 5dcb723 | 2021-11-08 23:24:14 -0800 | [diff] [blame] | 1042 | "cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones. |
| 1043 | "enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in. |
| 1044 | "kind": "dns#managedZoneCloudLoggingConfig", |
| 1045 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1046 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 1047 | "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. |
| 1048 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 1049 | "dnssecConfig": { # DNSSEC configuration. |
| 1050 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| 1051 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| 1052 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 1053 | "keyLength": 42, # Length of the keys in bits. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1054 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1055 | "kind": "dns#dnsKeySpec", |
| 1056 | }, |
| 1057 | ], |
| 1058 | "kind": "dns#managedZoneDnsSecConfig", |
| 1059 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 1060 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 1061 | }, |
| 1062 | "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. |
| 1063 | "kind": "dns#managedZoneForwardingConfig", |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1064 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1065 | { |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1066 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1067 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1068 | "ipv6Address": "A String", # IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1069 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 1070 | }, |
| 1071 | ], |
| 1072 | }, |
| 1073 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 1074 | "kind": "dns#managedZone", |
| 1075 | "labels": { # User labels. |
| 1076 | "a_key": "A String", |
| 1077 | }, |
| 1078 | "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. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1079 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1080 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 1081 | "A String", |
| 1082 | ], |
| 1083 | "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. |
| 1084 | "kind": "dns#managedZonePeeringConfig", |
| 1085 | "targetNetwork": { # The network with which to peer. |
| 1086 | "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. |
| 1087 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 1088 | "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} |
| 1089 | }, |
| 1090 | }, |
| 1091 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| yoshi-code-bot | 9e2cde2 | 2021-04-29 03:48:05 -0700 | [diff] [blame] | 1092 | "gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone. |
| 1093 | { |
| 1094 | "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 |
| 1095 | "kind": "dns#managedZonePrivateVisibilityConfigGKECluster", |
| 1096 | }, |
| 1097 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1098 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| 1099 | "networks": [ # The list of VPC networks that can see this zone. |
| 1100 | { |
| 1101 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1102 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1103 | }, |
| 1104 | ], |
| 1105 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1106 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1107 | "kind": "dns#managedZoneReverseLookupConfig", |
| 1108 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1109 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1110 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 1111 | "namespace": { # Contains information about the namespace associated with the zone. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1112 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1113 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1114 | "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} |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1115 | }, |
| 1116 | }, |
| 1117 | "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. |
| 1118 | }, |
| 1119 | }, |
| 1120 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1121 | </div> |
| 1122 | |
| 1123 | </body></html> |