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

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

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Bu Sun Kim

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

[diff] [blame^]

75

<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.managedZoneOperations.html">managedZoneOperations</a></h1>

Bu Sun Kim

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

[diff] [blame^]

78

<code><a href="#get">get(project, managedZone, operation, clientOperationId=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Fetch the representation of an existing Operation.</p>

Bu Sun Kim

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

[diff] [blame]

80

Bu Sun Kim

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

[diff] [blame^]

81

<code><a href="#list">list(project, managedZone, sortBy=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Enumerate Operations for the given ManagedZone.</p>

Bu Sun Kim

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

[diff] [blame]

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

Bu Sun Kim

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

[diff] [blame^]

88

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

89

<pre>Fetch the representation of an existing Operation.

Bu Sun Kim

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

[diff] [blame]

90

91

Args:

Bu Sun Kim

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

[diff] [blame^]

92

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

93

managedZone: string, Identifies the managed zone addressed by this request. (required)

94

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

95

clientOperationId: string, For mutating operation requests only. An optional identifier

96

specified by the client. Must be unique for operation resources in the

97

Operations collection.

98

x__xgafv: string, V1 error format.

99

Allowed values

100

1 - v1 error format

101

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

102

103

Returns:

104

An object of the form:

105

Bu Sun Kim

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

[diff] [blame^]

106

{ # An operation represents a successful mutation performed on a Cloud DNS

107

# resource.

108

# Operations provide:

109

# - An audit log of server resource mutations.

110

# - A way to recover/retry API calls in the case where the response is never

111

# received by the caller. Use the caller specified client_operation_id.

112

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

113

# (output only).

114

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

115

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

116

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

117

# for the user's convenience. Has no effect on the resource's function.

118

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

119

# DnsKey. These digests are needed to construct a DS record that points at

120

# this DNS key. Output only.

Bu Sun Kim

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

[diff] [blame]

121

{

Bu Sun Kim

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

[diff] [blame^]

122

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

123

# resource record.

124

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

Bu Sun Kim

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

[diff] [blame]

125

},

126

],

Bu Sun Kim

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

[diff] [blame^]

127

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

128

# Secure Entry Point flag set and, when active, will be used to sign only

129

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

130

# flag will be cleared and this key will be used to sign only resource

131

# record sets of other types. Immutable after creation time.

132

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

133

# RFC3339 text format. Output only.

134

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

135

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

136

# Inactive keys will still be present as DNSKEY Resource Records for the use

137

# of resolvers validating existing signatures.

138

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

139

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

140

# more quickly (but it is not a unique identifier). In particular, the key

141

# tag is used in a parent zone's DS record to point at the DNSKEY in this

142

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

143

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

144

"kind": "dns#dnsKey",

145

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

146

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

147

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

148

# after creation time.

Bu Sun Kim

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

[diff] [blame]

149

},

Bu Sun Kim

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

[diff] [blame^]

150

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

151

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

152

# for the user's convenience. Has no effect on the resource's function.

153

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

154

# DnsKey. These digests are needed to construct a DS record that points at

155

# this DNS key. Output only.

Bu Sun Kim

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

[diff] [blame]

156

{

Bu Sun Kim

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

[diff] [blame^]

157

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

158

# resource record.

159

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

Bu Sun Kim

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

[diff] [blame]

160

},

161

],

Bu Sun Kim

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

[diff] [blame^]

162

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

163

# Secure Entry Point flag set and, when active, will be used to sign only

164

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

165

# flag will be cleared and this key will be used to sign only resource

166

# record sets of other types. Immutable after creation time.

167

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

168

# RFC3339 text format. Output only.

169

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

170

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

171

# Inactive keys will still be present as DNSKEY Resource Records for the use

172

# of resolvers validating existing signatures.

173

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

174

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

175

# more quickly (but it is not a unique identifier). In particular, the key

176

# tag is used in a parent zone's DS record to point at the DNSKEY in this

177

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

178

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

179

"kind": "dns#dnsKey",

180

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

181

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

182

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

183

# after creation time.

Bu Sun Kim

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

[diff] [blame]

184

},

185

},

Bu Sun Kim

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

[diff] [blame^]

186

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

187

"newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource.

188

# responsibility. A ManagedZone is a resource that represents a DNS zone

189

# hosted by the Cloud DNS service.

190

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

191

# text format. Output only.

192

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

193

# zone. The value of this field contains the network to peer with.

194

"kind": "dns#managedZonePeeringConfig",

195

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

196

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

197

# format. An empty string indicates that the peering connection is

198

# active. The producer network can deactivate a zone. The zone is

199

# automatically deactivated if the producer network that the zone

200

# targeted is deleted. Output only.

201

"kind": "dns#managedZonePeeringConfigTargetNetwork",

202

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

203

# This should be formatted like

204

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

205

},

Bu Sun Kim

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

[diff] [blame]

206

},

Bu Sun Kim

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

[diff] [blame^]

207

"dnssecConfig": { # DNSSEC configuration.

208

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

209

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

210

# Can only be changed while the state is OFF.

211

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

212

# ManagedZone. Can only be changed while the state is OFF.

213

{ # Parameters for DnsKey key generation. Used for generating initial keys

214

# for a new ManagedZone and as default when adding a new DnsKey.

215

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

216

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

217

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

218

# active, will only be used to sign resource record sets of type DNSKEY.

219

# Zone signing keys do not have the Secure Entry Point flag set and will be

220

# used to sign all other types of resource record sets.

221

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

222

"kind": "dns#dnsKeySpec",

223

},

224

],

225

"kind": "dns#managedZoneDnsSecConfig",

226

},

227

"name": "A String", # User assigned name for this resource. Must be unique within the project.

228

# The name must be 1-63 characters long, must begin with a letter, end with

229

# a letter or digit, and only contain lowercase letters, digits or dashes.

230

"labels": { # User labels.

231

"a_key": "A String",

232

},

233

"kind": "dns#managedZone",

234

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

235

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

236

# private zones are visible only to Virtual Private Cloud resources.

237

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

238

# that the zone is visible from.

239

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

Bu Sun Kim

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

[diff] [blame]

240

{

Bu Sun Kim

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

[diff] [blame^]

241

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

242

# This should be formatted like

243

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

244

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

245

},

246

],

247

"kind": "dns#managedZonePrivateVisibilityConfig",

248

},

249

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

250

# NameServerSet is a set of DNS name servers that all host the same

251

# ManagedZones. Most users will leave this field unset.

252

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

253

# for this zone. The value of this field contains the set of destinations

254

# to forward to.

255

"kind": "dns#managedZoneForwardingConfig",

256

"targetNameServers": [ # List of target name servers to forward to.

257

# Cloud DNS will select the best available name server if more than one

258

# target is given.

259

{

260

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

261

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

262

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

263

# Cloud DNS will make forwarding decision based on address ranges,

264

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

265

# Internet. When set to PRIVATE, Cloud DNS will always send queries

266

# through VPC for this target

Bu Sun Kim

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

[diff] [blame]

267

},

268

],

269

},

Bu Sun Kim

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

[diff] [blame^]

270

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

271

# server (output only)

272

"A String",

273

],

274

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

275

# lookup zone and Cloud DNS will resolve reverse lookup queries using

276

# automatically configured records for VPC resources. This only applies

277

# to networks listed under private_visibility_config.

278

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

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

[diff] [blame]

279

},

Bu Sun Kim

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

[diff] [blame^]

280

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

281

# for the user's convenience. Has no effect on the managed zone's function.

282

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

Bu Sun Kim

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

[diff] [blame]

283

},

Bu Sun Kim

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

[diff] [blame^]

284

"oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource.

285

# responsibility. A ManagedZone is a resource that represents a DNS zone

286

# hosted by the Cloud DNS service.

287

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

288

# text format. Output only.

289

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

290

# zone. The value of this field contains the network to peer with.

291

"kind": "dns#managedZonePeeringConfig",

292

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

293

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

294

# format. An empty string indicates that the peering connection is

295

# active. The producer network can deactivate a zone. The zone is

296

# automatically deactivated if the producer network that the zone

297

# targeted is deleted. Output only.

298

"kind": "dns#managedZonePeeringConfigTargetNetwork",

299

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

300

# This should be formatted like

301

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

302

},

Bu Sun Kim

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

[diff] [blame]

303

},

Bu Sun Kim

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

[diff] [blame^]

304

"dnssecConfig": { # DNSSEC configuration.

305

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

306

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

307

# Can only be changed while the state is OFF.

308

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

309

# ManagedZone. Can only be changed while the state is OFF.

310

{ # Parameters for DnsKey key generation. Used for generating initial keys

311

# for a new ManagedZone and as default when adding a new DnsKey.

312

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

313

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

314

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

315

# active, will only be used to sign resource record sets of type DNSKEY.

316

# Zone signing keys do not have the Secure Entry Point flag set and will be

317

# used to sign all other types of resource record sets.

318

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

319

"kind": "dns#dnsKeySpec",

320

},

321

],

322

"kind": "dns#managedZoneDnsSecConfig",

323

},

324

"name": "A String", # User assigned name for this resource. Must be unique within the project.

325

# The name must be 1-63 characters long, must begin with a letter, end with

326

# a letter or digit, and only contain lowercase letters, digits or dashes.

327

"labels": { # User labels.

328

"a_key": "A String",

329

},

330

"kind": "dns#managedZone",

331

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

332

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

333

# private zones are visible only to Virtual Private Cloud resources.

334

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

335

# that the zone is visible from.

336

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

Bu Sun Kim

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

[diff] [blame]

337

{

Bu Sun Kim

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

[diff] [blame^]

338

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

339

# This should be formatted like

340

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

341

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

342

},

343

],

344

"kind": "dns#managedZonePrivateVisibilityConfig",

345

},

346

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

347

# NameServerSet is a set of DNS name servers that all host the same

348

# ManagedZones. Most users will leave this field unset.

349

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

350

# for this zone. The value of this field contains the set of destinations

351

# to forward to.

352

"kind": "dns#managedZoneForwardingConfig",

353

"targetNameServers": [ # List of target name servers to forward to.

354

# Cloud DNS will select the best available name server if more than one

355

# target is given.

356

{

357

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

358

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

359

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

360

# Cloud DNS will make forwarding decision based on address ranges,

361

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

362

# Internet. When set to PRIVATE, Cloud DNS will always send queries

363

# through VPC for this target

Bu Sun Kim

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

[diff] [blame]

364

},

365

],

366

},

Bu Sun Kim

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

[diff] [blame^]

367

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

368

# server (output only)

369

"A String",

370

],

371

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

372

# lookup zone and Cloud DNS will resolve reverse lookup queries using

373

# automatically configured records for VPC resources. This only applies

374

# to networks listed under private_visibility_config.

375

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

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

[diff] [blame]

376

},

Bu Sun Kim

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

[diff] [blame^]

377

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

378

# for the user's convenience. Has no effect on the managed zone's function.

379

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

Bu Sun Kim

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

[diff] [blame]

380

},

381

},

Bu Sun Kim

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

[diff] [blame^]

382

"id": "A String", # Unique identifier for the resource. This is the client_operation_id if

383

# the client specified it when the mutation was initiated, otherwise,

384

# it is generated by the server. The name must be 1-63 characters long

385

# and match the regular expression [-a-z0-9]? (output only)

386

"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339

387

# text format (output only).

388

"user": "A String", # User who requested the operation, for example: user@example.com.

389

# cloud-dns-system for operations automatically done by the system.

390

# (output only)

391

"kind": "dns#operation",

392

"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE"

393

# (output only). A status of "DONE" means that the

394

# request to update the authoritative servers has been sent, but the

395

# servers might not be updated yet.

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^]

400

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

401

<pre>Enumerate Operations for the given ManagedZone.

Bu Sun Kim

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

[diff] [blame]

402

403

Args:

Bu Sun Kim

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

[diff] [blame^]

404

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

405

managedZone: string, Identifies the managed zone addressed by this request. (required)

406

sortBy: string, Sorting criterion. The only supported values are START_TIME and ID.

407

maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the

408

server will decide how many results to return.

409

pageToken: string, Optional. A tag returned by a previous list request that was truncated.

410

Use this parameter to continue a previous list request.

411

x__xgafv: string, V1 error format.

Bu Sun Kim

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

[diff] [blame]

412

Allowed values

Bu Sun Kim

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

[diff] [blame^]

413

1 - v1 error format

414

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

415

416

Returns:

417

An object of the form:

418

419

{

Bu Sun Kim

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

[diff] [blame^]

420

"nextPageToken": "A String", # The presence of this field indicates that there exist more results

421

# following your last page of results in pagination order. To fetch them,

422

# make another list request using this value as your page token.

423

#

424

# In this way you can retrieve the complete contents of even very large

425

# collections one page at a time. However, if the contents of the collection

426

# change between the first and last paginated list request, the set of all

427

# elements returned will be an inconsistent view of the collection. There is

428

# no way to retrieve a consistent snapshot of a collection larger than the

429

# maximum page size.

430

"kind": "dns#managedZoneOperationsListResponse",

431

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

432

"operationId": "A String", # For mutating operation requests that completed successfully.

433

# This is the client_operation_id if the client specified it,

434

# otherwise it is generated by the server (output only).

Bu Sun Kim

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

[diff] [blame]

435

},

Bu Sun Kim

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

[diff] [blame^]

436

"operations": [ # The operation resources.

437

{ # An operation represents a successful mutation performed on a Cloud DNS

438

# resource.

439

# Operations provide:

440

# - An audit log of server resource mutations.

441

# - A way to recover/retry API calls in the case where the response is never

442

# received by the caller. Use the caller specified client_operation_id.

443

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

444

# (output only).

445

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

446

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

447

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

448

# for the user's convenience. Has no effect on the resource's function.

449

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

450

# DnsKey. These digests are needed to construct a DS record that points at

451

# this DNS key. Output only.

Bu Sun Kim

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

[diff] [blame]

452

{

Bu Sun Kim

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

[diff] [blame^]

453

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

454

# resource record.

455

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

Bu Sun Kim

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

[diff] [blame]

456

},

457

],

Bu Sun Kim

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

[diff] [blame^]

458

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

459

# Secure Entry Point flag set and, when active, will be used to sign only

460

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

461

# flag will be cleared and this key will be used to sign only resource

462

# record sets of other types. Immutable after creation time.

463

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

464

# RFC3339 text format. Output only.

465

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

466

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

467

# Inactive keys will still be present as DNSKEY Resource Records for the use

468

# of resolvers validating existing signatures.

469

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

470

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

471

# more quickly (but it is not a unique identifier). In particular, the key

472

# tag is used in a parent zone's DS record to point at the DNSKEY in this

473

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

474

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

475

"kind": "dns#dnsKey",

476

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

477

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

478

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

479

# after creation time.

Bu Sun Kim

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

[diff] [blame]

480

},

Bu Sun Kim

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

[diff] [blame^]

481

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

482

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

483

# for the user's convenience. Has no effect on the resource's function.

484

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

485

# DnsKey. These digests are needed to construct a DS record that points at

486

# this DNS key. Output only.

Bu Sun Kim

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

[diff] [blame]

487

{

Bu Sun Kim

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

[diff] [blame^]

488

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

489

# resource record.

490

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

Bu Sun Kim

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

[diff] [blame]

491

},

492

],

Bu Sun Kim

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

[diff] [blame^]

493

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

494

# Secure Entry Point flag set and, when active, will be used to sign only

495

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

496

# flag will be cleared and this key will be used to sign only resource

497

# record sets of other types. Immutable after creation time.

498

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

499

# RFC3339 text format. Output only.

500

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

501

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

502

# Inactive keys will still be present as DNSKEY Resource Records for the use

503

# of resolvers validating existing signatures.

504

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

505

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

506

# more quickly (but it is not a unique identifier). In particular, the key

507

# tag is used in a parent zone's DS record to point at the DNSKEY in this

508

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

509

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

510

"kind": "dns#dnsKey",

511

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

512

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

513

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

514

# after creation time.

Bu Sun Kim

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

[diff] [blame]

515

},

516

},

Bu Sun Kim

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

[diff] [blame^]

517

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

518

"newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource.

519

# responsibility. A ManagedZone is a resource that represents a DNS zone

520

# hosted by the Cloud DNS service.

521

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

522

# text format. Output only.

523

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

524

# zone. The value of this field contains the network to peer with.

525

"kind": "dns#managedZonePeeringConfig",

526

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

527

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

528

# format. An empty string indicates that the peering connection is

529

# active. The producer network can deactivate a zone. The zone is

530

# automatically deactivated if the producer network that the zone

531

# targeted is deleted. Output only.

532

"kind": "dns#managedZonePeeringConfigTargetNetwork",

533

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

534

# This should be formatted like

535

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

536

},

Bu Sun Kim

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

[diff] [blame]

537

},

Bu Sun Kim

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

[diff] [blame^]

538

"dnssecConfig": { # DNSSEC configuration.

539

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

540

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

541

# Can only be changed while the state is OFF.

542

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

543

# ManagedZone. Can only be changed while the state is OFF.

544

{ # Parameters for DnsKey key generation. Used for generating initial keys

545

# for a new ManagedZone and as default when adding a new DnsKey.

546

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

547

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

548

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

549

# active, will only be used to sign resource record sets of type DNSKEY.

550

# Zone signing keys do not have the Secure Entry Point flag set and will be

551

# used to sign all other types of resource record sets.

552

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

553

"kind": "dns#dnsKeySpec",

554

},

555

],

556

"kind": "dns#managedZoneDnsSecConfig",

557

},

558

"name": "A String", # User assigned name for this resource. Must be unique within the project.

559

# The name must be 1-63 characters long, must begin with a letter, end with

560

# a letter or digit, and only contain lowercase letters, digits or dashes.

561

"labels": { # User labels.

562

"a_key": "A String",

563

},

564

"kind": "dns#managedZone",

565

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

566

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

567

# private zones are visible only to Virtual Private Cloud resources.

568

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

569

# that the zone is visible from.

570

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

Bu Sun Kim

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

[diff] [blame]

571

{

Bu Sun Kim

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

[diff] [blame^]

572

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

573

# This should be formatted like

574

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

575

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

576

},

577

],

578

"kind": "dns#managedZonePrivateVisibilityConfig",

579

},

580

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

581

# NameServerSet is a set of DNS name servers that all host the same

582

# ManagedZones. Most users will leave this field unset.

583

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

584

# for this zone. The value of this field contains the set of destinations

585

# to forward to.

586

"kind": "dns#managedZoneForwardingConfig",

587

"targetNameServers": [ # List of target name servers to forward to.

588

# Cloud DNS will select the best available name server if more than one

589

# target is given.

590

{

591

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

592

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

593

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

594

# Cloud DNS will make forwarding decision based on address ranges,

595

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

596

# Internet. When set to PRIVATE, Cloud DNS will always send queries

597

# through VPC for this target

Bu Sun Kim

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

[diff] [blame]

598

},

599

],

600

},

Bu Sun Kim

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

[diff] [blame^]

601

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

602

# server (output only)

603

"A String",

604

],

605

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

606

# lookup zone and Cloud DNS will resolve reverse lookup queries using

607

# automatically configured records for VPC resources. This only applies

608

# to networks listed under private_visibility_config.

609

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

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

[diff] [blame]

610

},

Bu Sun Kim

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

[diff] [blame^]

611

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

612

# for the user's convenience. Has no effect on the managed zone's function.

613

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

Bu Sun Kim

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

[diff] [blame]

614

},

Bu Sun Kim

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

[diff] [blame^]

615

"oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource.

616

# responsibility. A ManagedZone is a resource that represents a DNS zone

617

# hosted by the Cloud DNS service.

618

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

619

# text format. Output only.

620

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

621

# zone. The value of this field contains the network to peer with.

622

"kind": "dns#managedZonePeeringConfig",

623

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

624

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

625

# format. An empty string indicates that the peering connection is

626

# active. The producer network can deactivate a zone. The zone is

627

# automatically deactivated if the producer network that the zone

628

# targeted is deleted. Output only.

629

"kind": "dns#managedZonePeeringConfigTargetNetwork",

630

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

631

# This should be formatted like

632

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

633

},

Bu Sun Kim

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

[diff] [blame]

634

},

Bu Sun Kim

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

[diff] [blame^]

635

"dnssecConfig": { # DNSSEC configuration.

636

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

637

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

638

# Can only be changed while the state is OFF.

639

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

640

# ManagedZone. Can only be changed while the state is OFF.

641

{ # Parameters for DnsKey key generation. Used for generating initial keys

642

# for a new ManagedZone and as default when adding a new DnsKey.

643

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

644

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

645

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

646

# active, will only be used to sign resource record sets of type DNSKEY.

647

# Zone signing keys do not have the Secure Entry Point flag set and will be

648

# used to sign all other types of resource record sets.

649

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

650

"kind": "dns#dnsKeySpec",

651

},

652

],

653

"kind": "dns#managedZoneDnsSecConfig",

654

},

655

"name": "A String", # User assigned name for this resource. Must be unique within the project.

656

# The name must be 1-63 characters long, must begin with a letter, end with

657

# a letter or digit, and only contain lowercase letters, digits or dashes.

658

"labels": { # User labels.

659

"a_key": "A String",

660

},

661

"kind": "dns#managedZone",

662

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

663

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

664

# private zones are visible only to Virtual Private Cloud resources.

665

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

666

# that the zone is visible from.

667

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

Bu Sun Kim

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

[diff] [blame]

668

{

Bu Sun Kim

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

[diff] [blame^]

669

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

670

# This should be formatted like

671

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

672

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

673

},

674

],

675

"kind": "dns#managedZonePrivateVisibilityConfig",

676

},

677

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

678

# NameServerSet is a set of DNS name servers that all host the same

679

# ManagedZones. Most users will leave this field unset.

680

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

681

# for this zone. The value of this field contains the set of destinations

682

# to forward to.

683

"kind": "dns#managedZoneForwardingConfig",

684

"targetNameServers": [ # List of target name servers to forward to.

685

# Cloud DNS will select the best available name server if more than one

686

# target is given.

687

{

688

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

689

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

690

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

691

# Cloud DNS will make forwarding decision based on address ranges,

692

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

693

# Internet. When set to PRIVATE, Cloud DNS will always send queries

694

# through VPC for this target

Bu Sun Kim

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

[diff] [blame]

695

},

696

],

697

},

Bu Sun Kim

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

[diff] [blame^]

698

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

699

# server (output only)

700

"A String",

701

],

702

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

703

# lookup zone and Cloud DNS will resolve reverse lookup queries using

704

# automatically configured records for VPC resources. This only applies

705

# to networks listed under private_visibility_config.

706

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

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

[diff] [blame]

707

},

Bu Sun Kim

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

[diff] [blame^]

708

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

709

# for the user's convenience. Has no effect on the managed zone's function.

710

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

Bu Sun Kim

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

[diff] [blame]

711

},

712

},

Bu Sun Kim

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

[diff] [blame^]

713

"id": "A String", # Unique identifier for the resource. This is the client_operation_id if

714

# the client specified it when the mutation was initiated, otherwise,

715

# it is generated by the server. The name must be 1-63 characters long

716

# and match the regular expression [-a-z0-9]? (output only)

717

"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339

718

# text format (output only).

719

"user": "A String", # User who requested the operation, for example: user@example.com.

720

# cloud-dns-system for operations automatically done by the system.

721

# (output only)

722

"kind": "dns#operation",

723

"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE"

724

# (output only). A status of "DONE" means that the

725

# request to update the authoritative servers has been sent, but the

726

# servers might not be updated yet.

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

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

734

<pre>Retrieves the next page of results.

735

736

Args:

737

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

738

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

739

740

Returns:

Bu Sun Kim

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

[diff] [blame]

741

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

Bu Sun Kim