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

Nathaniel Manista

4f877e5

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

[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.changes.html">changes</a></h1>

Nathaniel Manista

4f877e5

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

d059ad8

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

[diff] [blame]

78

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

79

<p class="firstline">Atomically update the ResourceRecordSet collection.</p>

Nathaniel Manista

4f877e5

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

[diff] [blame]

80

Bu Sun Kim

d059ad8

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

[diff] [blame]

81

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

82

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

Nathaniel Manista

4f877e5

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

[diff] [blame]

83

Bu Sun Kim

d059ad8

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

[diff] [blame]

84

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

85

<p class="firstline">Enumerate Changes to a ResourceRecordSet collection.</p>

Nathaniel Manista

4f877e5

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

[diff] [blame]

86

87

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

88

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

89

<h3>Method Details</h3>

90

Bu Sun Kim

d059ad8

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

[diff] [blame]

91

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

92

<pre>Atomically update the ResourceRecordSet collection.

Nathaniel Manista

4f877e5

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

[diff] [blame]

93

94

Args:

Bu Sun Kim

d059ad8

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

[diff] [blame]

95

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

96

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

97

zone name or id. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

98

body: object, The request body.

Nathaniel Manista

4f877e5

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

[diff] [blame]

99

The object takes the form of:

100

Bu Sun Kim

d059ad8

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

[diff] [blame]

101

{ # A Change represents a set of ResourceRecordSet additions and deletions

102

# applied atomically to a ManagedZone. ResourceRecordSets within a

103

# ManagedZone are modified by creating a new Change element in the Changes

104

# collection. In turn the Changes collection also records the past

105

# modifications to the ResourceRecordSets in a ManagedZone. The current

106

# state of the ManagedZone is the sum effect of applying all Change

107

# elements in the Changes collection in sequence.

108

"kind": "dns#change",

109

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

110

# is in RFC3339 text format.

111

"isServing": True or False, # If the DNS queries for the zone will be served.

112

"additions": [ # Which ResourceRecordSets to add?

113

{ # A unit of data that will be returned by the DNS servers.

114

"kind": "dns#resourceRecordSet",

115

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

116

"A String",

Nathaniel Manista

4f877e5

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

[diff] [blame]

117

],

Bu Sun Kim

d059ad8

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

[diff] [blame]

118

"type": "A String", # The identifier of a supported record type. See the list of

119

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

120

# DNS record types</a>.

121

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

122

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

123

# <a href="/dns/records/json-record">examples</a>.

124

"A String",

Nathaniel Manista

4f877e5

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

[diff] [blame]

125

],

Bu Sun Kim

d059ad8

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

[diff] [blame]

126

"name": "A String", # For example, www.example.com.

Bu Sun Kim

6502091

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

[diff] [blame]

127

},

Bu Sun Kim

d059ad8

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

[diff] [blame]

128

],

129

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

130

"status": "A String", # Status of the operation (output only). A status of "done" means that the

131

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

132

# servers might not be updated yet.

133

"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.

134

{ # A unit of data that will be returned by the DNS servers.

135

"kind": "dns#resourceRecordSet",

136

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

137

"A String",

138

],

139

"type": "A String", # The identifier of a supported record type. See the list of

140

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

141

# DNS record types</a>.

142

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

143

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

144

# <a href="/dns/records/json-record">examples</a>.

145

"A String",

146

],

147

"name": "A String", # For example, www.example.com.

},

],

}

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

153

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

154

Operations collection.

155

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

162

163

{ # A Change represents a set of ResourceRecordSet additions and deletions

164

# applied atomically to a ManagedZone. ResourceRecordSets within a

165

# ManagedZone are modified by creating a new Change element in the Changes

166

# collection. In turn the Changes collection also records the past

167

# modifications to the ResourceRecordSets in a ManagedZone. The current

168

# state of the ManagedZone is the sum effect of applying all Change

169

# elements in the Changes collection in sequence.

170

"kind": "dns#change",

171

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

172

# is in RFC3339 text format.

173

"isServing": True or False, # If the DNS queries for the zone will be served.

174

"additions": [ # Which ResourceRecordSets to add?

175

{ # A unit of data that will be returned by the DNS servers.

176

"kind": "dns#resourceRecordSet",

177

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

178

"A String",

179

],

180

"type": "A String", # The identifier of a supported record type. See the list of

181

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

182

# DNS record types</a>.

183

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

184

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

185

# <a href="/dns/records/json-record">examples</a>.

186

"A String",

187

],

188

"name": "A String", # For example, www.example.com.

189

},

190

],

191

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

192

"status": "A String", # Status of the operation (output only). A status of "done" means that the

193

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

194

# servers might not be updated yet.

195

"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.

196

{ # A unit of data that will be returned by the DNS servers.

197

"kind": "dns#resourceRecordSet",

198

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

199

"A String",

200

],

201

"type": "A String", # The identifier of a supported record type. See the list of

202

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

203

# DNS record types</a>.

204

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

205

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

206

# <a href="/dns/records/json-record">examples</a>.

207

"A String",

208

],

209

"name": "A String", # For example, www.example.com.

},

],

}</pre>

</div>

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

217

<pre>Fetch the representation of an existing Change.

218

219

Args:

220

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

221

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

222

zone name or id. (required)

223

changeId: string, The identifier of the requested change, from a previous

224

ResourceRecordSetsChangeResponse. (required)

225

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

226

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

227

Operations collection.

228

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

235

236

{ # A Change represents a set of ResourceRecordSet additions and deletions

237

# applied atomically to a ManagedZone. ResourceRecordSets within a

238

# ManagedZone are modified by creating a new Change element in the Changes

239

# collection. In turn the Changes collection also records the past

240

# modifications to the ResourceRecordSets in a ManagedZone. The current

241

# state of the ManagedZone is the sum effect of applying all Change

242

# elements in the Changes collection in sequence.

243

"kind": "dns#change",

244

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

245

# is in RFC3339 text format.

246

"isServing": True or False, # If the DNS queries for the zone will be served.

247

"additions": [ # Which ResourceRecordSets to add?

248

{ # A unit of data that will be returned by the DNS servers.

249

"kind": "dns#resourceRecordSet",

250

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

251

"A String",

252

],

253

"type": "A String", # The identifier of a supported record type. See the list of

254

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

255

# DNS record types</a>.

256

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

257

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

258

# <a href="/dns/records/json-record">examples</a>.

259

"A String",

260

],

261

"name": "A String", # For example, www.example.com.

262

},

263

],

264

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

265

"status": "A String", # Status of the operation (output only). A status of "done" means that the

266

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

267

# servers might not be updated yet.

268

"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.

269

{ # A unit of data that will be returned by the DNS servers.

270

"kind": "dns#resourceRecordSet",

271

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

272

"A String",

273

],

274

"type": "A String", # The identifier of a supported record type. See the list of

275

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

276

# DNS record types</a>.

277

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

278

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

279

# <a href="/dns/records/json-record">examples</a>.

280

"A String",

281

],

282

"name": "A String", # For example, www.example.com.

},

],

}</pre>

</div>

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

290

<pre>Enumerate Changes to a ResourceRecordSet collection.

291

292

Args:

293

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

294

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

295

zone name or id. (required)

296

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

297

Use this parameter to continue a previous list request.

298

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

299

server will decide how many results to return.

300

sortBy: string, Sorting criterion. The only supported value is change sequence.

301

sortOrder: string, Sorting order direction: 'ascending' or 'descending'.

302

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

309

310

{ # The response to a request to enumerate Changes to a ResourceRecordSets

311

# collection.

312

"changes": [ # The requested changes.

313

{ # A Change represents a set of ResourceRecordSet additions and deletions

314

# applied atomically to a ManagedZone. ResourceRecordSets within a

315

# ManagedZone are modified by creating a new Change element in the Changes

316

# collection. In turn the Changes collection also records the past

317

# modifications to the ResourceRecordSets in a ManagedZone. The current

318

# state of the ManagedZone is the sum effect of applying all Change

319

# elements in the Changes collection in sequence.

320

"kind": "dns#change",

321

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

322

# is in RFC3339 text format.

323

"isServing": True or False, # If the DNS queries for the zone will be served.

324

"additions": [ # Which ResourceRecordSets to add?

325

{ # A unit of data that will be returned by the DNS servers.

326

"kind": "dns#resourceRecordSet",

327

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

328

"A String",

329

],

330

"type": "A String", # The identifier of a supported record type. See the list of

331

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

332

# DNS record types</a>.

333

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

334

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

335

# <a href="/dns/records/json-record">examples</a>.

336

"A String",

337

],

338

"name": "A String", # For example, www.example.com.

339

},

340

],

341

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

342

"status": "A String", # Status of the operation (output only). A status of "done" means that the

343

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

344

# servers might not be updated yet.

345

"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.

346

{ # A unit of data that will be returned by the DNS servers.

347

"kind": "dns#resourceRecordSet",

348

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).

349

"A String",

350

],

351

"type": "A String", # The identifier of a supported record type. See the list of

352

# <a href="/dns/docs/overview#supported_dns_record_types">Supported

353

# DNS record types</a>.

354

"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.

355

"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see

356

# <a href="/dns/records/json-record">examples</a>.

357

"A String",

358

],

359

"name": "A String", # For example, www.example.com.

},

],

},

],

Bu Sun Kim

6502091

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

[diff] [blame]

364

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

365

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

366

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

367

# This is the client_operation_id if the client specified it,

368

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

369

},

370

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

371

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

372

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

373

#

374

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

375

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

376

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

377

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

378

# no way to retrieve a "snapshot" of collections larger than the maximum

379

# page size.

Nathaniel Manista

4f877e5

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

[diff] [blame]

}</pre>

</div>

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

385

<pre>Retrieves the next page of results.

386

387

Args:

388

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

389

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

390

391

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

392

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

Nathaniel Manista

4f877e5

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

[diff] [blame]

393

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

</pre>

</div>

</body></html>