1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
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>
<h1><a href="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.changes.html">changes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(project, managedZone, body, clientOperationId=None)</a></code></p>
<p class="firstline">Atomically update the ResourceRecordSet collection.</p>
<p class="toc_element">
<code><a href="#get">get(project, managedZone, changeId, clientOperationId=None)</a></code></p>
<p class="firstline">Fetch the representation of an existing Change.</p>
<p class="toc_element">
<code><a href="#list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</a></code></p>
<p class="firstline">Enumerate Changes to a ResourceRecordSet collection.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(project, managedZone, body, clientOperationId=None)</code>
<pre>Atomically update the ResourceRecordSet collection.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
"isServing": True or False, # If the DNS queries for the zone will be served.
"startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns:
An object of the form:
{ # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
"isServing": True or False, # If the DNS queries for the zone will be served.
"startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None)</code>
<pre>Fetch the representation of an existing Change.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns:
An object of the form:
{ # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
"isServing": True or False, # If the DNS queries for the zone will be served.
"startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</code>
<pre>Enumerate Changes to a ResourceRecordSet collection.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
sortBy: string, Sorting criterion. The only supported value is change sequence.
Allowed values
changeSequence -
sortOrder: string, Sorting order direction: 'ascending' or 'descending'.
Returns:
An object of the form:
{ # The response to a request to enumerate Changes to a ResourceRecordSets collection.
"nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
#
# In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
"header": { # Elements common to every response.
"operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
},
"kind": "dns#changesListResponse", # Type of resource.
"changes": [ # The requested changes.
{ # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
"isServing": True or False, # If the DNS queries for the zone will be served.
"startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
