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

2016-10-21 13:59:49 -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_v2beta1.html">Cloud DNS API</a> . <a href="dns_v2beta1.managedZoneOperations.html">managedZoneOperations</a></h1>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

80

Bu Sun Kim

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

[diff] [blame]

81

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

82

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

Sai Cheemalapati

2016-10-21 13:59:49 -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.

Sai Cheemalapati

2016-10-21 13:59:49 -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

Sai Cheemalapati

2016-10-21 13:59:49 -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

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

113

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

114

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

115

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

116

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

117

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

118

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

119

# hosted by the Cloud DNS service.

120

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

121

# server (output only)

122

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

123

],

Bu Sun Kim

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

[diff] [blame]

124

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

125

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

126

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

127

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

128

# ManagedZones. Most users will leave this field unset.

129

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

130

# that the zone is visible from.

131

"kind": "dns#managedZonePrivateVisibilityConfig",

132

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

133

{

134

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

135

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

136

# This should be formatted like

137

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

},

],

},

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

142

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

143

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

144

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

145

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

146

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

147

# text format. Output only.

148

"labels": { # User labels.

149

"a_key": "A String",

150

},

151

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

152

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

153

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

154

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

155

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

156

# This should be formatted like

157

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

158

"kind": "dns#managedZonePeeringConfigTargetNetwork",

159

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

160

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

161

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

162

# automatically deactivated if the producer network that the zone

163

# targeted is deleted. Output only.

164

},

165

"kind": "dns#managedZonePeeringConfig",

166

},

167

"dnssecConfig": { # DNSSEC configuration.

168

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

169

# Can only be changed while the state is OFF.

170

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

171

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

172

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

173

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

174

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

175

"kind": "dns#dnsKeySpec",

176

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

177

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

178

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

179

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

180

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

181

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

182

},

183

],

184

"kind": "dns#managedZoneDnsSecConfig",

185

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

186

},

187

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

188

"kind": "dns#managedZone",

189

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

190

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

191

# automatically configured records for VPC resources. This only applies

192

# to networks listed under private_visibility_config.

193

"kind": "dns#managedZoneReverseLookupConfig",

194

},

195

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

196

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

197

# to forward to.

198

"kind": "dns#managedZoneForwardingConfig",

199

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

200

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

201

# target is given.

202

{

203

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

204

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

205

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

206

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

207

# through VPC for this target

208

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

209

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

210

},

211

],

212

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

213

},

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

216

# hosted by the Cloud DNS service.

217

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

218

# server (output only)

219

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

220

],

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

223

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

224

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

225

# ManagedZones. Most users will leave this field unset.

226

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

227

# that the zone is visible from.

228

"kind": "dns#managedZonePrivateVisibilityConfig",

229

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

230

{

231

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

232

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

233

# This should be formatted like

234

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

},

],

},

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

239

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

240

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

241

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

242

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

243

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

244

# text format. Output only.

245

"labels": { # User labels.

246

"a_key": "A String",

247

},

248

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

249

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

250

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

251

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

252

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

253

# This should be formatted like

254

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

255

"kind": "dns#managedZonePeeringConfigTargetNetwork",

256

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

257

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

258

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

259

# automatically deactivated if the producer network that the zone

260

# targeted is deleted. Output only.

261

},

262

"kind": "dns#managedZonePeeringConfig",

263

},

264

"dnssecConfig": { # DNSSEC configuration.

265

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

266

# Can only be changed while the state is OFF.

267

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

268

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

269

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

270

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

271

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

272

"kind": "dns#dnsKeySpec",

273

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

274

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

275

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

276

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

277

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

278

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

279

},

280

],

281

"kind": "dns#managedZoneDnsSecConfig",

282

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

283

},

284

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

285

"kind": "dns#managedZone",

286

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

287

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

288

# automatically configured records for VPC resources. This only applies

289

# to networks listed under private_visibility_config.

290

"kind": "dns#managedZoneReverseLookupConfig",

291

},

292

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

293

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

294

# to forward to.

295

"kind": "dns#managedZoneForwardingConfig",

296

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

297

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

298

# target is given.

299

{

300

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

301

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

302

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

303

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

304

# through VPC for this target

305

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

306

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

307

},

308

],

309

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

310

},

311

},

Bu Sun Kim

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

[diff] [blame]

312

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

313

# (output only).

314

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

315

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

316

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

317

# servers might not be updated yet.

318

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

319

# text format (output only).

320

"kind": "dns#operation",

321

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

322

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

323

# (output only)

324

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

325

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

326

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

327

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

328

# of resolvers validating existing signatures.

329

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

330

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

331

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

332

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

333

# RFC3339 text format. Output only.

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

"kind": "dns#dnsKey",

346

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

347

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

348

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

349

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

350

# this DNS key. Output only.

351

{

352

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

353

# resource record.

354

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

Dan O'Meara

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

[diff] [blame]

355

},

Bu Sun Kim

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

[diff] [blame]

356

],

357

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

358

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

359

},

Bu Sun Kim

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

[diff] [blame]

360

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

361

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

362

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

363

# of resolvers validating existing signatures.

364

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

365

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

366

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

367

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

368

# RFC3339 text format. Output only.

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

"kind": "dns#dnsKey",

381

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

382

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

383

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

384

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

385

# this DNS key. Output only.

386

{

387

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

388

# resource record.

389

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

Dan O'Meara

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

[diff] [blame]

390

},

Bu Sun Kim

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

[diff] [blame]

391

],

392

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

393

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

394

},

395

},

Sai Cheemalapati

2016-10-21 13:59:49 -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, pageToken=None, sortBy=None, maxResults=None, x__xgafv=None)</code>

401

<pre>Enumerate Operations for the given ManagedZone.

Sai Cheemalapati

2016-10-21 13:59:49 -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

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

407

Use this parameter to continue a previous list request.

408

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

409

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

410

server will decide how many results to return.

411

x__xgafv: string, V1 error format.

Sai Cheemalapati

2016-10-21 13:59:49 -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

Sai Cheemalapati

2016-10-21 13:59:49 -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

"kind": "dns#managedZoneOperationsListResponse",

421

"operations": [ # The operation resources.

422

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

423

# resource.

424

# Operations provide:

425

# - An audit log of server resource mutations.

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

# hosted by the Cloud DNS service.

436

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

437

# server (output only)

438

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

439

],

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

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

443

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

444

# ManagedZones. Most users will leave this field unset.

445

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

446

# that the zone is visible from.

447

"kind": "dns#managedZonePrivateVisibilityConfig",

448

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

449

{

450

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

451

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

452

# This should be formatted like

453

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

},

],

},

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

458

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

459

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

460

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

461

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

462

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

463

# text format. Output only.

464

"labels": { # User labels.

465

"a_key": "A String",

466

},

467

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

468

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

469

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

470

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

471

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

472

# This should be formatted like

473

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

474

"kind": "dns#managedZonePeeringConfigTargetNetwork",

475

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

476

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

477

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

478

# automatically deactivated if the producer network that the zone

479

# targeted is deleted. Output only.

480

},

481

"kind": "dns#managedZonePeeringConfig",

482

},

483

"dnssecConfig": { # DNSSEC configuration.

484

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

485

# Can only be changed while the state is OFF.

486

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

487

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

488

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

489

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

490

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

491

"kind": "dns#dnsKeySpec",

492

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

493

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

494

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

495

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

496

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

497

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

498

},

499

],

500

"kind": "dns#managedZoneDnsSecConfig",

501

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

502

},

503

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

504

"kind": "dns#managedZone",

505

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

506

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

507

# automatically configured records for VPC resources. This only applies

508

# to networks listed under private_visibility_config.

509

"kind": "dns#managedZoneReverseLookupConfig",

510

},

511

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

512

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

513

# to forward to.

514

"kind": "dns#managedZoneForwardingConfig",

515

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

516

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

517

# target is given.

518

{

519

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

520

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

521

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

522

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

523

# through VPC for this target

524

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

525

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

526

},

527

],

528

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

529

},

Bu Sun Kim

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

[diff] [blame]

530

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

531

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

532

# hosted by the Cloud DNS service.

533

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

534

# server (output only)

535

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

536

],

Bu Sun Kim

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

[diff] [blame]

537

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

538

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

539

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

540

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

541

# ManagedZones. Most users will leave this field unset.

542

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

543

# that the zone is visible from.

544

"kind": "dns#managedZonePrivateVisibilityConfig",

545

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

546

{

547

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

548

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

549

# This should be formatted like

550

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

},

],

},

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

555

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

556

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

557

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

558

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

559

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

560

# text format. Output only.

561

"labels": { # User labels.

562

"a_key": "A String",

563

},

564

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

565

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

566

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

567

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

568

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

569

# This should be formatted like

570

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

571

"kind": "dns#managedZonePeeringConfigTargetNetwork",

572

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

573

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

574

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

575

# automatically deactivated if the producer network that the zone

576

# targeted is deleted. Output only.

577

},

578

"kind": "dns#managedZonePeeringConfig",

579

},

580

"dnssecConfig": { # DNSSEC configuration.

581

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

582

# Can only be changed while the state is OFF.

583

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

584

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

585

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

586

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

587

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

588

"kind": "dns#dnsKeySpec",

589

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

590

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

591

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

592

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

593

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

594

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

595

},

596

],

597

"kind": "dns#managedZoneDnsSecConfig",

598

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

599

},

600

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

601

"kind": "dns#managedZone",

602

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

603

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

604

# automatically configured records for VPC resources. This only applies

605

# to networks listed under private_visibility_config.

606

"kind": "dns#managedZoneReverseLookupConfig",

607

},

608

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

609

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

610

# to forward to.

611

"kind": "dns#managedZoneForwardingConfig",

612

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

613

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

614

# target is given.

615

{

616

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

617

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

618

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

619

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

620

# through VPC for this target

621

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

622

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

623

},

624

],

625

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

626

},

627

},

Bu Sun Kim

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

[diff] [blame]

628

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

629

# (output only).

630

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

631

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

632

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

633

# servers might not be updated yet.

634

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

635

# text format (output only).

636

"kind": "dns#operation",

637

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

638

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

639

# (output only)

640

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

641

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

642

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

643

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

644

# of resolvers validating existing signatures.

645

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

646

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

647

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

648

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

649

# RFC3339 text format. Output only.

650

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

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

"kind": "dns#dnsKey",

662

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

663

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

664

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

665

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

666

# this DNS key. Output only.

667

{

668

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

669

# resource record.

670

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

Dan O'Meara

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

[diff] [blame]

671

},

Bu Sun Kim

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

[diff] [blame]

672

],

673

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

674

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

675

},

Bu Sun Kim

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

[diff] [blame]

676

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

677

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

678

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

679

# of resolvers validating existing signatures.

680

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

681

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

682

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

683

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

684

# RFC3339 text format. Output only.

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

"kind": "dns#dnsKey",

697

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

698

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

699

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

700

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

701

# this DNS key. Output only.

702

{

703

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

704

# resource record.

705

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

Dan O'Meara

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

[diff] [blame]

706

},

Bu Sun Kim

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

[diff] [blame]

707

],

708

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

709

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

710

},

711

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

712

},

713

],

Bu Sun Kim

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

[diff] [blame]

714

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

715

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

716

# This is the client_operation_id if the client specified it,

717

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

718

},

719

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

720

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

721

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

722

#

723

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

724

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

725

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

726

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

727

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

728

# maximum page size.

Sai Cheemalapati

2016-10-21 13:59:49 -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

6502091

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

[diff] [blame]

741

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

Sai Cheemalapati