docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/dns_v1.managedZoneOperations.html b/docs/dyn/dns_v1.managedZoneOperations.html
index 6dc71d7..c9edb52 100644
--- a/docs/dyn/dns_v1.managedZoneOperations.html
+++ b/docs/dyn/dns_v1.managedZoneOperations.html
@@ -75,16 +75,24 @@
<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.managedZoneOperations.html">managedZoneOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#get">get(project, managedZone, operation, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetch the representation of an existing Operation.</p>
<p class="toc_element">
- <code><a href="#list">list(project, managedZone, sortBy=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(project, managedZone, pageToken=None, sortBy=None, maxResults=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enumerate Operations for the given ManagedZone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(project, managedZone, operation, clientOperationId=None, x__xgafv=None)</code>
<pre>Fetch the representation of an existing Operation.
@@ -92,9 +100,7 @@
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. (required)
operation: string, Identifies the operation addressed by this request. (required)
- clientOperationId: string, For mutating operation requests only. An optional identifier
-specified by the client. Must be unique for operation resources in the
-Operations collection.
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -103,311 +109,187 @@
Returns:
An object of the form:
- { # An operation represents a successful mutation performed on a Cloud DNS
- # resource.
- # Operations provide:
- # - An audit log of server resource mutations.
- # - A way to recover/retry API calls in the case where the response is never
- # received by the caller. Use the caller specified client_operation_id.
- "type": "A String", # Type of the operation. Operations include insert, update, and delete
- # (output only).
- "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
- "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource
- # for the user's convenience. Has no effect on the resource's function.
- "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this
- # DnsKey. These digests are needed to construct a DS record that points at
- # this DNS key. Output only.
- {
- "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS
- # resource record.
- "type": "A String", # Specifies the algorithm used to calculate this digest.
- },
- ],
- "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, will be used to sign only
- # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point
- # flag will be cleared and this key will be used to sign only resource
- # record sets of other types. Immutable after creation time.
- "creationTime": "A String", # The time that this resource was created in the control plane. This is in
- # RFC3339 text format. Output only.
- "publicKey": "A String", # Base64 encoded public half of this key. Output only.
- "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.
- # Inactive keys will still be present as DNSKEY Resource Records for the use
- # of resolvers validating existing signatures.
- "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record
- # associated with this DnsKey. The key tag can be used to identify a DNSKEY
- # more quickly (but it is not a unique identifier). In particular, the key
- # tag is used in a parent zone's DS record to point at the DNSKEY in this
- # child ManagedZone. The key tag is a number in the range [0, 65535] and the
- # algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
- "kind": "dns#dnsKey",
- "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable
- # after creation time.
- },
- "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource
- # for the user's convenience. Has no effect on the resource's function.
- "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this
- # DnsKey. These digests are needed to construct a DS record that points at
- # this DNS key. Output only.
- {
- "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS
- # resource record.
- "type": "A String", # Specifies the algorithm used to calculate this digest.
- },
- ],
- "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, will be used to sign only
- # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point
- # flag will be cleared and this key will be used to sign only resource
- # record sets of other types. Immutable after creation time.
- "creationTime": "A String", # The time that this resource was created in the control plane. This is in
- # RFC3339 text format. Output only.
- "publicKey": "A String", # Base64 encoded public half of this key. Output only.
- "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.
- # Inactive keys will still be present as DNSKEY Resource Records for the use
- # of resolvers validating existing signatures.
- "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record
- # associated with this DnsKey. The key tag can be used to identify a DNSKEY
- # more quickly (but it is not a unique identifier). In particular, the key
- # tag is used in a parent zone's DS record to point at the DNSKEY in this
- # child ManagedZone. The key tag is a number in the range [0, 65535] and the
- # algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
- "kind": "dns#dnsKey",
- "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable
- # after creation time.
- },
- },
+ { # 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.
"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
- "newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource.
- # responsibility. A ManagedZone is a resource that represents a DNS zone
- # hosted by the Cloud DNS service.
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339
- # text format. Output only.
- "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this
- # zone. The value of this field contains the network to peer with.
- "kind": "dns#managedZonePeeringConfig",
- "targetNetwork": { # The network with which to peer.
- "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time
- # format. An empty string indicates that the peering connection is
- # active. The producer network can deactivate a zone. The zone is
- # automatically deactivated if the producer network that the zone
- # targeted is deleted. Output only.
- "kind": "dns#managedZonePeeringConfigTargetNetwork",
- "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- },
- },
+ "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.
"dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig",
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
- "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.
- # Can only be changed while the state is OFF.
- "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this
- # ManagedZone. Can only be changed while the state is OFF.
- { # Parameters for DnsKey key generation. Used for generating initial keys
- # for a new ManagedZone and as default when adding a new DnsKey.
+ "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"keyLength": 42, # Length of the keys in bits.
- "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key
- # (ZSK). Key signing keys have the Secure Entry Point flag set and, when
- # active, will only be used to sign resource record sets of type DNSKEY.
- # Zone signing keys do not have the Secure Entry Point flag set and will be
- # used to sign all other types of resource record sets.
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ "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, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
},
],
- "kind": "dns#managedZoneDnsSecConfig",
+ "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
},
- "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.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "kind": "dns#managedZone",
+ "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 will leave this field unset.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
+ "targetNetwork": { # The network with which to peer.
+ "kind": "dns#managedZonePeeringConfigTargetNetwork",
+ "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.
+ "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}
+ },
+ "kind": "dns#managedZonePeeringConfig",
+ },
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
+ "kind": "dns#managedZoneForwardingConfig",
+ "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given.
+ {
+ "kind": "dns#managedZoneForwardingConfigNameServerTarget",
+ "forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target.
+ "ipv4Address": "A String", # IPv4 address of a target name server.
+ },
+ ],
+ },
"labels": { # User labels.
"a_key": "A String",
},
- "kind": "dns#managedZone",
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "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.
- "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources
- # that the zone is visible from.
- "networks": [ # The list of VPC networks that can see this zone.
- {
- "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
- },
- ],
- "kind": "dns#managedZonePrivateVisibilityConfig",
- },
- "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 will leave this field unset.
- "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled
- # for this zone. The value of this field contains the set of destinations
- # to forward to.
- "kind": "dns#managedZoneForwardingConfig",
- "targetNameServers": [ # List of target name servers to forward to.
- # Cloud DNS will select the best available name server if more than one
- # target is given.
- {
- "kind": "dns#managedZoneForwardingConfigNameServerTarget",
- "ipv4Address": "A String", # IPv4 address of a target name server.
- "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,
- # Cloud DNS will make forwarding decision based on address ranges,
- # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
- # Internet. When set to PRIVATE, Cloud DNS will always send queries
- # through VPC for this target
- },
- ],
- },
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the
- # server (output only)
- "A String",
- ],
- "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse
- # lookup zone and Cloud DNS will resolve reverse lookup queries using
- # automatically configured records for VPC resources. This only applies
- # to networks listed under private_visibility_config.
+ "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS will resolve reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
- "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.
+ "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.
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
+ "kind": "dns#managedZonePrivateVisibilityConfig",
+ "networks": [ # The list of VPC networks that can see this zone.
+ {
+ "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ },
+ "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.
},
- "oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource.
- # responsibility. A ManagedZone is a resource that represents a DNS zone
- # hosted by the Cloud DNS service.
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339
- # text format. Output only.
- "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this
- # zone. The value of this field contains the network to peer with.
- "kind": "dns#managedZonePeeringConfig",
- "targetNetwork": { # The network with which to peer.
- "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time
- # format. An empty string indicates that the peering connection is
- # active. The producer network can deactivate a zone. The zone is
- # automatically deactivated if the producer network that the zone
- # targeted is deleted. Output only.
- "kind": "dns#managedZonePeeringConfigTargetNetwork",
- "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- },
- },
+ "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.
"dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig",
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
- "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.
- # Can only be changed while the state is OFF.
- "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this
- # ManagedZone. Can only be changed while the state is OFF.
- { # Parameters for DnsKey key generation. Used for generating initial keys
- # for a new ManagedZone and as default when adding a new DnsKey.
+ "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"keyLength": 42, # Length of the keys in bits.
- "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key
- # (ZSK). Key signing keys have the Secure Entry Point flag set and, when
- # active, will only be used to sign resource record sets of type DNSKEY.
- # Zone signing keys do not have the Secure Entry Point flag set and will be
- # used to sign all other types of resource record sets.
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ "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, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
},
],
- "kind": "dns#managedZoneDnsSecConfig",
+ "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
},
- "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.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "kind": "dns#managedZone",
+ "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 will leave this field unset.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
+ "targetNetwork": { # The network with which to peer.
+ "kind": "dns#managedZonePeeringConfigTargetNetwork",
+ "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.
+ "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}
+ },
+ "kind": "dns#managedZonePeeringConfig",
+ },
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
+ "kind": "dns#managedZoneForwardingConfig",
+ "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given.
+ {
+ "kind": "dns#managedZoneForwardingConfigNameServerTarget",
+ "forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target.
+ "ipv4Address": "A String", # IPv4 address of a target name server.
+ },
+ ],
+ },
"labels": { # User labels.
"a_key": "A String",
},
- "kind": "dns#managedZone",
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "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.
- "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources
- # that the zone is visible from.
- "networks": [ # The list of VPC networks that can see this zone.
- {
- "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
- },
- ],
- "kind": "dns#managedZonePrivateVisibilityConfig",
- },
- "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 will leave this field unset.
- "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled
- # for this zone. The value of this field contains the set of destinations
- # to forward to.
- "kind": "dns#managedZoneForwardingConfig",
- "targetNameServers": [ # List of target name servers to forward to.
- # Cloud DNS will select the best available name server if more than one
- # target is given.
- {
- "kind": "dns#managedZoneForwardingConfigNameServerTarget",
- "ipv4Address": "A String", # IPv4 address of a target name server.
- "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,
- # Cloud DNS will make forwarding decision based on address ranges,
- # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
- # Internet. When set to PRIVATE, Cloud DNS will always send queries
- # through VPC for this target
- },
- ],
- },
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the
- # server (output only)
- "A String",
- ],
- "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse
- # lookup zone and Cloud DNS will resolve reverse lookup queries using
- # automatically configured records for VPC resources. This only applies
- # to networks listed under private_visibility_config.
+ "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS will resolve reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
- "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.
+ "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.
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
+ "kind": "dns#managedZonePrivateVisibilityConfig",
+ "networks": [ # The list of VPC networks that can see this zone.
+ {
+ "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ },
+ "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.
},
},
- "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)
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339
- # text format (output only).
- "user": "A String", # User who requested the operation, for example: user@example.com.
- # cloud-dns-system for operations automatically done by the system.
- # (output only)
+ "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)
+ "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
+ "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "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.
+ "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.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "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.
+ "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, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "kind": "dns#dnsKey",
+ },
+ "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "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.
+ "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.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "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.
+ "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, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "kind": "dns#dnsKey",
+ },
+ },
+ "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
+ "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
+ "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
"kind": "dns#operation",
- "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.
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, managedZone, sortBy=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(project, managedZone, pageToken=None, sortBy=None, maxResults=None, x__xgafv=None)</code>
<pre>Enumerate Operations for the given ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. (required)
+ pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
sortBy: string, Sorting criterion. The only supported values are START_TIME and ID.
- maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the
-server will decide how many results to return.
- pageToken: string, Optional. A tag returned by a previous list request that was truncated.
-Use this parameter to continue a previous list request.
+ Allowed values
+ startTime -
+ id -
+ maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -417,315 +299,179 @@
An object of the form:
{
- "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.
- #
- # In this way you can retrieve 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 will be an inconsistent view of the collection. There is
- # no way to retrieve a consistent snapshot of a collection larger than the
- # maximum page size.
- "kind": "dns#managedZoneOperationsListResponse",
- "header": { # Elements common to every response.
- "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).
- },
+ "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. In this way you can retrieve 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 will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
"operations": [ # The operation resources.
- { # 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.
- "type": "A String", # Type of the operation. Operations include insert, update, and delete
- # (output only).
- "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
- "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource
- # for the user's convenience. Has no effect on the resource's function.
- "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this
- # DnsKey. These digests are needed to construct a DS record that points at
- # this DNS key. Output only.
- {
- "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS
- # resource record.
- "type": "A String", # Specifies the algorithm used to calculate this digest.
- },
- ],
- "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, will be used to sign only
- # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point
- # flag will be cleared and this key will be used to sign only resource
- # record sets of other types. Immutable after creation time.
- "creationTime": "A String", # The time that this resource was created in the control plane. This is in
- # RFC3339 text format. Output only.
- "publicKey": "A String", # Base64 encoded public half of this key. Output only.
- "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.
- # Inactive keys will still be present as DNSKEY Resource Records for the use
- # of resolvers validating existing signatures.
- "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record
- # associated with this DnsKey. The key tag can be used to identify a DNSKEY
- # more quickly (but it is not a unique identifier). In particular, the key
- # tag is used in a parent zone's DS record to point at the DNSKEY in this
- # child ManagedZone. The key tag is a number in the range [0, 65535] and the
- # algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
- "kind": "dns#dnsKey",
- "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable
- # after creation time.
- },
- "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource
- # for the user's convenience. Has no effect on the resource's function.
- "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this
- # DnsKey. These digests are needed to construct a DS record that points at
- # this DNS key. Output only.
- {
- "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS
- # resource record.
- "type": "A String", # Specifies the algorithm used to calculate this digest.
- },
- ],
- "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, will be used to sign only
- # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point
- # flag will be cleared and this key will be used to sign only resource
- # record sets of other types. Immutable after creation time.
- "creationTime": "A String", # The time that this resource was created in the control plane. This is in
- # RFC3339 text format. Output only.
- "publicKey": "A String", # Base64 encoded public half of this key. Output only.
- "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.
- # Inactive keys will still be present as DNSKEY Resource Records for the use
- # of resolvers validating existing signatures.
- "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record
- # associated with this DnsKey. The key tag can be used to identify a DNSKEY
- # more quickly (but it is not a unique identifier). In particular, the key
- # tag is used in a parent zone's DS record to point at the DNSKEY in this
- # child ManagedZone. The key tag is a number in the range [0, 65535] and the
- # algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
- "kind": "dns#dnsKey",
- "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable
- # after creation time.
- },
- },
+ { # 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.
"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
- "newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource.
- # responsibility. A ManagedZone is a resource that represents a DNS zone
- # hosted by the Cloud DNS service.
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339
- # text format. Output only.
- "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this
- # zone. The value of this field contains the network to peer with.
- "kind": "dns#managedZonePeeringConfig",
- "targetNetwork": { # The network with which to peer.
- "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time
- # format. An empty string indicates that the peering connection is
- # active. The producer network can deactivate a zone. The zone is
- # automatically deactivated if the producer network that the zone
- # targeted is deleted. Output only.
- "kind": "dns#managedZonePeeringConfigTargetNetwork",
- "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- },
- },
+ "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.
"dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig",
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
- "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.
- # Can only be changed while the state is OFF.
- "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this
- # ManagedZone. Can only be changed while the state is OFF.
- { # Parameters for DnsKey key generation. Used for generating initial keys
- # for a new ManagedZone and as default when adding a new DnsKey.
+ "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"keyLength": 42, # Length of the keys in bits.
- "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key
- # (ZSK). Key signing keys have the Secure Entry Point flag set and, when
- # active, will only be used to sign resource record sets of type DNSKEY.
- # Zone signing keys do not have the Secure Entry Point flag set and will be
- # used to sign all other types of resource record sets.
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ "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, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
},
],
- "kind": "dns#managedZoneDnsSecConfig",
+ "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
},
- "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.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "kind": "dns#managedZone",
+ "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 will leave this field unset.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
+ "targetNetwork": { # The network with which to peer.
+ "kind": "dns#managedZonePeeringConfigTargetNetwork",
+ "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.
+ "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}
+ },
+ "kind": "dns#managedZonePeeringConfig",
+ },
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
+ "kind": "dns#managedZoneForwardingConfig",
+ "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given.
+ {
+ "kind": "dns#managedZoneForwardingConfigNameServerTarget",
+ "forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target.
+ "ipv4Address": "A String", # IPv4 address of a target name server.
+ },
+ ],
+ },
"labels": { # User labels.
"a_key": "A String",
},
- "kind": "dns#managedZone",
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "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.
- "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources
- # that the zone is visible from.
- "networks": [ # The list of VPC networks that can see this zone.
- {
- "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
- },
- ],
- "kind": "dns#managedZonePrivateVisibilityConfig",
- },
- "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 will leave this field unset.
- "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled
- # for this zone. The value of this field contains the set of destinations
- # to forward to.
- "kind": "dns#managedZoneForwardingConfig",
- "targetNameServers": [ # List of target name servers to forward to.
- # Cloud DNS will select the best available name server if more than one
- # target is given.
- {
- "kind": "dns#managedZoneForwardingConfigNameServerTarget",
- "ipv4Address": "A String", # IPv4 address of a target name server.
- "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,
- # Cloud DNS will make forwarding decision based on address ranges,
- # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
- # Internet. When set to PRIVATE, Cloud DNS will always send queries
- # through VPC for this target
- },
- ],
- },
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the
- # server (output only)
- "A String",
- ],
- "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse
- # lookup zone and Cloud DNS will resolve reverse lookup queries using
- # automatically configured records for VPC resources. This only applies
- # to networks listed under private_visibility_config.
+ "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS will resolve reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
- "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.
+ "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.
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
+ "kind": "dns#managedZonePrivateVisibilityConfig",
+ "networks": [ # The list of VPC networks that can see this zone.
+ {
+ "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ },
+ "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.
},
- "oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource.
- # responsibility. A ManagedZone is a resource that represents a DNS zone
- # hosted by the Cloud DNS service.
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339
- # text format. Output only.
- "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this
- # zone. The value of this field contains the network to peer with.
- "kind": "dns#managedZonePeeringConfig",
- "targetNetwork": { # The network with which to peer.
- "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time
- # format. An empty string indicates that the peering connection is
- # active. The producer network can deactivate a zone. The zone is
- # automatically deactivated if the producer network that the zone
- # targeted is deleted. Output only.
- "kind": "dns#managedZonePeeringConfigTargetNetwork",
- "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- },
- },
+ "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.
"dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig",
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
- "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.
- # Can only be changed while the state is OFF.
- "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this
- # ManagedZone. Can only be changed while the state is OFF.
- { # Parameters for DnsKey key generation. Used for generating initial keys
- # for a new ManagedZone and as default when adding a new DnsKey.
+ "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"keyLength": 42, # Length of the keys in bits.
- "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key
- # (ZSK). Key signing keys have the Secure Entry Point flag set and, when
- # active, will only be used to sign resource record sets of type DNSKEY.
- # Zone signing keys do not have the Secure Entry Point flag set and will be
- # used to sign all other types of resource record sets.
- "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ "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, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
},
],
- "kind": "dns#managedZoneDnsSecConfig",
+ "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
},
- "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.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "kind": "dns#managedZone",
+ "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 will leave this field unset.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
+ "targetNetwork": { # The network with which to peer.
+ "kind": "dns#managedZonePeeringConfigTargetNetwork",
+ "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.
+ "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}
+ },
+ "kind": "dns#managedZonePeeringConfig",
+ },
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
+ "kind": "dns#managedZoneForwardingConfig",
+ "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given.
+ {
+ "kind": "dns#managedZoneForwardingConfigNameServerTarget",
+ "forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target.
+ "ipv4Address": "A String", # IPv4 address of a target name server.
+ },
+ ],
+ },
"labels": { # User labels.
"a_key": "A String",
},
- "kind": "dns#managedZone",
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "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.
- "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources
- # that the zone is visible from.
- "networks": [ # The list of VPC networks that can see this zone.
- {
- "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
- # This should be formatted like
- # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
- "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
- },
- ],
- "kind": "dns#managedZonePrivateVisibilityConfig",
- },
- "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 will leave this field unset.
- "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled
- # for this zone. The value of this field contains the set of destinations
- # to forward to.
- "kind": "dns#managedZoneForwardingConfig",
- "targetNameServers": [ # List of target name servers to forward to.
- # Cloud DNS will select the best available name server if more than one
- # target is given.
- {
- "kind": "dns#managedZoneForwardingConfigNameServerTarget",
- "ipv4Address": "A String", # IPv4 address of a target name server.
- "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,
- # Cloud DNS will make forwarding decision based on address ranges,
- # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
- # Internet. When set to PRIVATE, Cloud DNS will always send queries
- # through VPC for this target
- },
- ],
- },
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the
- # server (output only)
- "A String",
- ],
- "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse
- # lookup zone and Cloud DNS will resolve reverse lookup queries using
- # automatically configured records for VPC resources. This only applies
- # to networks listed under private_visibility_config.
+ "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS will resolve reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
- "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.
+ "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.
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
+ "kind": "dns#managedZonePrivateVisibilityConfig",
+ "networks": [ # The list of VPC networks that can see this zone.
+ {
+ "kind": "dns#managedZonePrivateVisibilityConfigNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ },
+ "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.
},
},
- "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)
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339
- # text format (output only).
- "user": "A String", # User who requested the operation, for example: user@example.com.
- # cloud-dns-system for operations automatically done by the system.
- # (output only)
+ "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)
+ "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
+ "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "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.
+ "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.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "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.
+ "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, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "kind": "dns#dnsKey",
+ },
+ "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "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.
+ "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.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "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.
+ "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, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "kind": "dns#dnsKey",
+ },
+ },
+ "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
+ "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
+ "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
"kind": "dns#operation",
- "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.
+ "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.
},
],
+ "header": { # Elements common to every response.
+ "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).
+ },
+ "kind": "dns#managedZoneOperationsListResponse",
}</pre>
</div>