Blame - docs/dyn/dns_v1.managedZones.html - platform/external/python/google-api-python-client

2020-11-16 11:05:03 -0700

[diff] [blame]

117

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

118

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

119

"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.

120

"kind": "dns#managedZoneReverseLookupConfig",

121

},

122

"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.

123

"kind": "dns#managedZonePeeringConfig",

124

"targetNetwork": { # The network with which to peer.

125

"kind": "dns#managedZonePeeringConfigTargetNetwork",

126

"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}

127

"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.

128

},

129

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

130

"labels": { # User labels.

131

"a_key": "A String",

132

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

133

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

134

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

135

"kind": "dns#managedZoneForwardingConfig",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

136

"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.

137

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

138

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

139

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

140

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

141

},

142

],

143

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

144

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

145

"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.

146

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

147

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

148

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

149

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

150

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

151

"kind": "dns#managedZoneDnsSecConfig",

152

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

153

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

154

"kind": "dns#dnsKeySpec",

155

"keyLength": 42, # Length of the keys in bits.

156

"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.

157

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

158

},

159

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

160

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

161

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

162

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

163

"A String",

164

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

165

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

166

"networks": [ # The list of VPC networks that can see this zone.

167

{

168

"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}

169

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

170

},

171

],

172

"kind": "dns#managedZonePrivateVisibilityConfig",

173

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

174

}

175

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

176

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

2020-07-22 17:02:09 -0700

[diff] [blame]

177

x__xgafv: string, V1 error format.

178

Allowed values

179

1 - v1 error format

180

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

181

182

Returns:

183

An object of the form:

184

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

185

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

186

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

187

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

188

"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.

189

"kind": "dns#managedZoneReverseLookupConfig",

190

},

191

"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.

192

"kind": "dns#managedZonePeeringConfig",

193

"targetNetwork": { # The network with which to peer.

194

"kind": "dns#managedZonePeeringConfigTargetNetwork",

195

"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}

196

"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.

197

},

198

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

199

"labels": { # User labels.

200

"a_key": "A String",

201

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

202

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

203

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

204

"kind": "dns#managedZoneForwardingConfig",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

205

"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.

206

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

207

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

208

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

209

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

210

},

211

],

212

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

213

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

214

"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.

215

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

216

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

217

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

218

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

219

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

220

"kind": "dns#managedZoneDnsSecConfig",

221

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

222

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

223

"kind": "dns#dnsKeySpec",

224

"keyLength": 42, # Length of the keys in bits.

225

"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.

226

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

227

},

228

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

229

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

230

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

231

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

232

"A String",

233

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

234

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

235

"networks": [ # The list of VPC networks that can see this zone.

236

{

237

"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}

238

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

239

},

240

],

241

"kind": "dns#managedZonePrivateVisibilityConfig",

242

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

247

<code class="details" id="delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</code>

248

<pre>Delete a previously created ManagedZone.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

249

250

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

251

project: string, Identifies the project addressed by this request. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

252

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

253

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

2020-07-22 17:02:09 -0700

[diff] [blame]

254

x__xgafv: string, V1 error format.

255

Allowed values

256

1 - v1 error format

257

2 - v2 error format

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

262

<code class="details" id="get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</code>

263

<pre>Fetch the representation of an existing ManagedZone.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

264

265

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

266

project: string, Identifies the project addressed by this request. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

267

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

268

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

2020-07-22 17:02:09 -0700

[diff] [blame]

269

x__xgafv: string, V1 error format.

270

Allowed values

271

1 - v1 error format

272

2 - v2 error format

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

273

274

Returns:

275

An object of the form:

276

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

277

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

278

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

279

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

280

"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.

281

"kind": "dns#managedZoneReverseLookupConfig",

282

},

283

"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.

284

"kind": "dns#managedZonePeeringConfig",

285

"targetNetwork": { # The network with which to peer.

286

"kind": "dns#managedZonePeeringConfigTargetNetwork",

287

"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}

288

"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.

289

},

290

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

291

"labels": { # User labels.

292

"a_key": "A String",

293

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

294

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

295

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

296

"kind": "dns#managedZoneForwardingConfig",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

297

"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.

298

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

299

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

300

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

301

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

302

},

303

],

304

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

305

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

306

"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.

307

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

308

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

309

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

310

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

311

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

312

"kind": "dns#managedZoneDnsSecConfig",

313

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

314

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

315

"kind": "dns#dnsKeySpec",

316

"keyLength": 42, # Length of the keys in bits.

317

"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.

318

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

319

},

320

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

321

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

322

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

323

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

324

"A String",

325

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

326

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

327

"networks": [ # The list of VPC networks that can see this zone.

328

{

329

"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}

330

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

331

},

332

],

333

"kind": "dns#managedZonePrivateVisibilityConfig",

334

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

339

<code class="details" id="list">list(project, pageToken=None, dnsName=None, maxResults=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

340

<pre>Enumerate ManagedZones that have been created but not yet deleted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

341

342

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

343

project: string, Identifies the project addressed by this request. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

344

pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

345

dnsName: string, Restricts the list to return only zones with this domain name.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

346

maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

347

x__xgafv: string, V1 error format.

348

Allowed values

349

1 - v1 error format

350

2 - v2 error format

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

351

352

Returns:

353

An object of the form:

354

355

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

356

"kind": "dns#managedZonesListResponse", # Type of resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

357

"header": { # Elements common to every response.

358

"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).

359

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

360

"managedZones": [ # The managed zone resources.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

361

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

362

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

363

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

364

"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.

365

"kind": "dns#managedZoneReverseLookupConfig",

366

},

367

"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.

368

"kind": "dns#managedZonePeeringConfig",

369

"targetNetwork": { # The network with which to peer.

370

"kind": "dns#managedZonePeeringConfigTargetNetwork",

371

"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}

372

"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.

373

},

374

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

375

"labels": { # User labels.

376

"a_key": "A String",

377

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

378

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

379

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

380

"kind": "dns#managedZoneForwardingConfig",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

381

"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.

382

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

383

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

384

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

385

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

386

},

387

],

388

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

389

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

390

"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.

391

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

392

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

393

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

394

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

395

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

396

"kind": "dns#managedZoneDnsSecConfig",

397

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

398

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

399

"kind": "dns#dnsKeySpec",

400

"keyLength": 42, # Length of the keys in bits.

401

"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.

402

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

403

},

404

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

405

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

406

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

407

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

408

"A String",

409

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

410

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

411

"networks": [ # The list of VPC networks that can see this zone.

412

{

413

"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}

414

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

415

},

416

],

417

"kind": "dns#managedZonePrivateVisibilityConfig",

418

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

419

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

420

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

421

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

427

<pre>Retrieves the next page of results.

428

429

Args:

430

previous_request: The request for the previous page. (required)

431

previous_response: The response from the request for the previous page. (required)

432

433

Returns:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

434

A request object that you can call 'execute()' on to request the next

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

435

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

439

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

440

<code class="details" id="patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>

441

<pre>Apply a partial update to an existing ManagedZone.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

442

443

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

444

project: string, Identifies the project addressed by this request. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

445

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]

446

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

447

The object takes the form of:

448

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

449

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

450

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

451

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

452

"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.

453

"kind": "dns#managedZoneReverseLookupConfig",

454

},

455

"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.

456

"kind": "dns#managedZonePeeringConfig",

457

"targetNetwork": { # The network with which to peer.

458

"kind": "dns#managedZonePeeringConfigTargetNetwork",

459

"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}

460

"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.

461

},

462

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

463

"labels": { # User labels.

464

"a_key": "A String",

465

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

466

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

467

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

468

"kind": "dns#managedZoneForwardingConfig",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

469

"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.

470

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

471

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

472

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

473

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

474

},

475

],

476

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

477

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

478

"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.

479

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

480

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

481

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

482

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

483

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

484

"kind": "dns#managedZoneDnsSecConfig",

485

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

486

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

487

"kind": "dns#dnsKeySpec",

488

"keyLength": 42, # Length of the keys in bits.

489

"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.

490

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

491

},

492

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

493

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

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

2020-11-24 15:48:03 -0800

[diff] [blame]

495

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

496

"A String",

497

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

498

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

499

"networks": [ # The list of VPC networks that can see this zone.

500

{

501

"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}

502

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

503

},

504

],

505

"kind": "dns#managedZonePrivateVisibilityConfig",

506

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

507

}

508

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

509

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

2020-07-22 17:02:09 -0700

[diff] [blame]

510

x__xgafv: string, V1 error format.

511

Allowed values

512

1 - v1 error format

513

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

514

515

Returns:

516

An object of the form:

517

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

518

{ # 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

2020-11-24 15:48:03 -0800

[diff] [blame]

519

"type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).

520

"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)

521

"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).

522

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

523

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

524

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

525

"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.

526

"kind": "dns#managedZoneReverseLookupConfig",

527

},

528

"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.

529

"kind": "dns#managedZonePeeringConfig",

530

"targetNetwork": { # The network with which to peer.

531

"kind": "dns#managedZonePeeringConfigTargetNetwork",

532

"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}

533

"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.

534

},

535

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

536

"labels": { # User labels.

537

"a_key": "A String",

538

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

539

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

540

"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.

541

"kind": "dns#managedZoneForwardingConfig",

542

"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.

543

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

544

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

545

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

546

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

547

},

548

],

549

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

550

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

551

"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.

552

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

553

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

554

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

555

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

556

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

557

"kind": "dns#managedZoneDnsSecConfig",

558

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

559

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

560

"kind": "dns#dnsKeySpec",

561

"keyLength": 42, # Length of the keys in bits.

562

"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.

563

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

564

},

565

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

566

},

567

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

568

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

569

"A String",

570

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

571

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

572

"networks": [ # The list of VPC networks that can see this zone.

573

{

574

"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}

575

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

576

},

577

],

578

"kind": "dns#managedZonePrivateVisibilityConfig",

579

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

580

},

581

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

582

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

583

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

584

"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.

585

"kind": "dns#managedZoneReverseLookupConfig",

586

},

587

"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.

588

"kind": "dns#managedZonePeeringConfig",

589

"targetNetwork": { # The network with which to peer.

590

"kind": "dns#managedZonePeeringConfigTargetNetwork",

591

"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}

592

"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.

593

},

594

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

595

"labels": { # User labels.

596

"a_key": "A String",

597

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

598

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

599

"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.

600

"kind": "dns#managedZoneForwardingConfig",

601

"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.

602

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

603

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

604

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

605

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

606

},

607

],

608

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

609

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

610

"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.

611

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

612

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

613

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

614

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

615

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

616

"kind": "dns#managedZoneDnsSecConfig",

617

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

618

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

619

"kind": "dns#dnsKeySpec",

620

"keyLength": 42, # Length of the keys in bits.

621

"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.

622

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

623

},

624

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

625

},

626

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

627

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

628

"A String",

629

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

630

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

631

"networks": [ # The list of VPC networks that can see this zone.

632

{

633

"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}

634

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

635

},

636

],

637

"kind": "dns#managedZonePrivateVisibilityConfig",

},

},

},

"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).

642

"kind": "dns#operation",

643

"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.

644

"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).

645

"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.

646

"kind": "dns#dnsKey",

647

"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.

648

"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.

649

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

650

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.

651

"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.

652

"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.

653

{

654

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.

655

"type": "A String", # Specifies the algorithm used to calculate this digest.

656

},

657

],

658

"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.

659

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

660

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

661

"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.

662

},

663

"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.

664

"kind": "dns#dnsKey",

665

"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.

666

"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.

667

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

668

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.

669

"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.

670

"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.

671

{

672

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.

673

"type": "A String", # Specifies the algorithm used to calculate this digest.

674

},

675

],

676

"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.

677

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

678

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

679

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

680

},

681

},

682

"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)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

687

<code class="details" id="update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>

688

<pre>Update an existing ManagedZone.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

689

690

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

691

project: string, Identifies the project addressed by this request. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

692

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]

693

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

694

The object takes the form of:

695

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

696

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

697

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

698

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

699

"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.

700

"kind": "dns#managedZoneReverseLookupConfig",

701

},

702

"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.

703

"kind": "dns#managedZonePeeringConfig",

704

"targetNetwork": { # The network with which to peer.

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

"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.

708

},

709

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

710

"labels": { # User labels.

711

"a_key": "A String",

712

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

713

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

714

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

715

"kind": "dns#managedZoneForwardingConfig",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

716

"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.

717

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

718

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

719

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

720

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

721

},

722

],

723

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

724

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

725

"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.

726

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

727

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

728

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

729

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

730

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

731

"kind": "dns#managedZoneDnsSecConfig",

732

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

733

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

734

"kind": "dns#dnsKeySpec",

735

"keyLength": 42, # Length of the keys in bits.

736

"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.

737

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

738

},

739

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

740

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

741

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

742

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

743

"A String",

744

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

745

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

746

"networks": [ # The list of VPC networks that can see this zone.

747

{

748

"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}

749

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

750

},

751

],

752

"kind": "dns#managedZonePrivateVisibilityConfig",

753

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

754

}

755

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

756

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

2020-07-22 17:02:09 -0700

[diff] [blame]

757

x__xgafv: string, V1 error format.

758

Allowed values

759

1 - v1 error format

760

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

761

762

Returns:

763

An object of the form:

764

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

765

{ # 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

2020-11-24 15:48:03 -0800

[diff] [blame]

766

"type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).

767

"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)

768

"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).

769

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

770

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

771

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

772

"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.

773

"kind": "dns#managedZoneReverseLookupConfig",

774

},

775

"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.

776

"kind": "dns#managedZonePeeringConfig",

777

"targetNetwork": { # The network with which to peer.

778

"kind": "dns#managedZonePeeringConfigTargetNetwork",

779

"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}

780

"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.

781

},

782

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

783

"labels": { # User labels.

784

"a_key": "A String",

785

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

786

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

787

"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.

788

"kind": "dns#managedZoneForwardingConfig",

789

"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.

790

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

791

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

792

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

793

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

794

},

795

],

796

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

797

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

798

"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.

799

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

800

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

801

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

802

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

803

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

804

"kind": "dns#managedZoneDnsSecConfig",

805

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

806

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

807

"kind": "dns#dnsKeySpec",

808

"keyLength": 42, # Length of the keys in bits.

809

"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.

810

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

811

},

812

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

813

},

814

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

815

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

816

"A String",

817

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

818

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

819

"networks": [ # The list of VPC networks that can see this zone.

820

{

821

"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}

822

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

823

},

824

],

825

"kind": "dns#managedZonePrivateVisibilityConfig",

826

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

827

},

828

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

829

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

830

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

831

"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.

832

"kind": "dns#managedZoneReverseLookupConfig",

833

},

834

"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.

835

"kind": "dns#managedZonePeeringConfig",

836

"targetNetwork": { # The network with which to peer.

837

"kind": "dns#managedZonePeeringConfigTargetNetwork",

838

"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}

839

"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.

840

},

841

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

842

"labels": { # User labels.

843

"a_key": "A String",

844

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

845

"kind": "dns#managedZone",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

846

"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.

847

"kind": "dns#managedZoneForwardingConfig",

848

"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.

849

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

850

"ipv4Address": "A String", # IPv4 address of a target name server.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

851

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

852

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

853

},

854

],

855

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

856

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

857

"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.

858

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

859

"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 Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

860

"dnssecConfig": { # DNSSEC configuration.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

861

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.

862

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

863

"kind": "dns#managedZoneDnsSecConfig",

864

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.

865

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

866

"kind": "dns#dnsKeySpec",

867

"keyLength": 42, # Length of the keys in bits.

868

"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.

869

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

870

},

871

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

872

},

873

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

874

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)

875

"A String",

876

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

877

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

878

"networks": [ # The list of VPC networks that can see this zone.

879

{

880

"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}

881

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

882

},

883

],

884

"kind": "dns#managedZonePrivateVisibilityConfig",

},

},

},

"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).

889

"kind": "dns#operation",

890

"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.

891

"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).

892

"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.

893

"kind": "dns#dnsKey",

894

"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.

895

"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.

896

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

897

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.

898

"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.

899

"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.

900

{

901

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.

902

"type": "A String", # Specifies the algorithm used to calculate this digest.

903

},

904

],

905

"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.

906

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

907

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

908

"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.

909

},

910

"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.

911

"kind": "dns#dnsKey",

912

"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.

913

"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.

914

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

915

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.

916

"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.

917

"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.

918

{

919

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.

920

"type": "A String", # Specifies the algorithm used to calculate this digest.

921

},

922

],

923

"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.

924

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

925

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

926

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

927

},

928

},

929

"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)

Bu Sun Kim