project STRING Required

Identifies the project addressed by this request

managedZone STRING Required

Identifies the managed zone addressed by this request. Can be the managed zone name or id

clientOperationId STRING

For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection

creationTime STRING

The time that this resource was created on the server. This is in RFC3339 text format. Output only

description STRING

A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function

dnsName STRING

The DNS name of this managed zone, for instance "example.com."

dnssecConfig OBJECT

dnssecConfig.defaultKeySpecs[] OBJECT

Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey

dnssecConfig.defaultKeySpecs[].algorithm ENUMERATION

String mnemonic specifying the DNSSEC algorithm of this key

dnssecConfig.defaultKeySpecs[].keyLength INTEGER

Length of the keys in bits

dnssecConfig.defaultKeySpecs[].keyType ENUMERATION

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

dnssecConfig.defaultKeySpecs[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec"

dnssecConfig.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig"

dnssecConfig.nonExistence ENUMERATION

Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF

dnssecConfig.state ENUMERATION

Specifies whether DNSSEC is enabled, and what mode it is in

id INTEGER

Unique identifier for the resource; defined by the server (output only)

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZone"

labels OBJECT

User labels

labels.customKey.value STRING Required

User labels

name STRING

User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes

nameServerSet 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[] STRING

privateVisibilityConfig OBJECT

privateVisibilityConfig.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig"

privateVisibilityConfig.networks[] OBJECT

privateVisibilityConfig.networks[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork"

privateVisibilityConfig.networks[].networkUrl 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}

visibility ENUMERATION

The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources

dnsKeyContext OBJECT

dnsKeyContext.newValue OBJECT

A DNSSEC key pair

dnsKeyContext.newValue.algorithm ENUMERATION

String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time

dnsKeyContext.newValue.creationTime STRING

The time that this resource was created in the control plane. This is in RFC3339 text format. Output only

dnsKeyContext.newValue.description 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

dnsKeyContext.newValue.digests[] OBJECT

dnsKeyContext.newValue.digests[].digest STRING

The base-16 encoded bytes of this digest. Suitable for use in a DS resource record

dnsKeyContext.newValue.digests[].type ENUMERATION

Specifies the algorithm used to calculate this digest

dnsKeyContext.newValue.id STRING

Unique identifier for the resource; defined by the server (output only)

dnsKeyContext.newValue.isActive BOOLEAN

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

dnsKeyContext.newValue.keyLength INTEGER

Length of the key in bits. Specified at creation time then immutable

dnsKeyContext.newValue.keyTag INTEGER

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

dnsKeyContext.newValue.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey"

dnsKeyContext.newValue.publicKey STRING

Base64 encoded public half of this key. Output only

dnsKeyContext.newValue.type ENUMERATION

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

dnsKeyContext.oldValue OBJECT

A DNSSEC key pair

dnsKeyContext.oldValue.algorithm ENUMERATION

String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time

dnsKeyContext.oldValue.creationTime STRING

The time that this resource was created in the control plane. This is in RFC3339 text format. Output only

dnsKeyContext.oldValue.description 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

dnsKeyContext.oldValue.digests[] OBJECT

dnsKeyContext.oldValue.digests[].digest STRING

The base-16 encoded bytes of this digest. Suitable for use in a DS resource record

dnsKeyContext.oldValue.digests[].type ENUMERATION

Specifies the algorithm used to calculate this digest

dnsKeyContext.oldValue.id STRING

Unique identifier for the resource; defined by the server (output only)

dnsKeyContext.oldValue.isActive BOOLEAN

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

dnsKeyContext.oldValue.keyLength INTEGER

Length of the key in bits. Specified at creation time then immutable

dnsKeyContext.oldValue.keyTag INTEGER

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

dnsKeyContext.oldValue.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey"

dnsKeyContext.oldValue.publicKey STRING

Base64 encoded public half of this key. Output only

dnsKeyContext.oldValue.type ENUMERATION

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

id 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 STRING

Identifies what kind of resource this is. Value: the fixed string "dns#operation"

startTime STRING

The time that this operation was started by the server. This is in RFC3339 text format (output only)

status ENUMERATION

Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet

type STRING

Type of the operation. Operations include insert, update, and delete (output only)

user STRING

User who requested the operation, for example: [email protected]. cloud-dns-system for operations automatically done by the system. (output only)

zoneContext OBJECT

zoneContext.newValue OBJECT

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

zoneContext.newValue.creationTime STRING

The time that this resource was created on the server. This is in RFC3339 text format. Output only

zoneContext.newValue.description 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

zoneContext.newValue.dnsName STRING

The DNS name of this managed zone, for instance "example.com."

zoneContext.newValue.dnssecConfig OBJECT

zoneContext.newValue.dnssecConfig.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig"

zoneContext.newValue.dnssecConfig.nonExistence ENUMERATION

Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF

zoneContext.newValue.dnssecConfig.state ENUMERATION

Specifies whether DNSSEC is enabled, and what mode it is in

zoneContext.newValue.id INTEGER

Unique identifier for the resource; defined by the server (output only)

zoneContext.newValue.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZone"

zoneContext.newValue.labels OBJECT

User labels

zoneContext.newValue.labels.customKey.value STRING

User labels

zoneContext.newValue.name 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

zoneContext.newValue.nameServerSet 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

zoneContext.newValue.nameServers[] STRING

zoneContext.newValue.privateVisibilityConfig OBJECT

zoneContext.newValue.privateVisibilityConfig.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig"

zoneContext.newValue.visibility ENUMERATION

The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources

zoneContext.oldValue OBJECT

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

zoneContext.oldValue.creationTime STRING

The time that this resource was created on the server. This is in RFC3339 text format. Output only

zoneContext.oldValue.description 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

zoneContext.oldValue.dnsName STRING

The DNS name of this managed zone, for instance "example.com."

zoneContext.oldValue.dnssecConfig OBJECT

zoneContext.oldValue.dnssecConfig.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig"

zoneContext.oldValue.dnssecConfig.nonExistence ENUMERATION

Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF

zoneContext.oldValue.dnssecConfig.state ENUMERATION

Specifies whether DNSSEC is enabled, and what mode it is in

zoneContext.oldValue.id INTEGER

Unique identifier for the resource; defined by the server (output only)

zoneContext.oldValue.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZone"

zoneContext.oldValue.labels OBJECT

User labels

zoneContext.oldValue.labels.customKey.value STRING

User labels

zoneContext.oldValue.name 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

zoneContext.oldValue.nameServerSet 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

zoneContext.oldValue.nameServers[] STRING

zoneContext.oldValue.privateVisibilityConfig OBJECT

zoneContext.oldValue.privateVisibilityConfig.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig"

zoneContext.oldValue.visibility ENUMERATION

The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources