Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / dns_v1.changes.html
blob: fe185f99b700d07ddd18434c1779ed6a91803fb2 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.changes.html">changes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(project, managedZone, body=None, clientOperationId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]79<p class="firstline">Atomically update the ResourceRecordSet collection.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#get">get(project, managedZone, changeId, clientOperationId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]82<p class="firstline">Fetch the representation of an existing Change.</p>
83<p class="toc_element">
84 <code><a href="#list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</a></code></p>
85<p class="firstline">Enumerate Changes to a ResourceRecordSet collection.</p>
86<p class="toc_element">
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<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <code class="details" id="create">create(project, managedZone, body=None, clientOperationId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92 <pre>Atomically update the ResourceRecordSet collection.
93
94Args:
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 zone name or id. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]98 The object takes the form of:
99
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100{ # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]101 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
102 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]104 "A String",
105 ],
106 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]107 "name": "A String", # For example, www.example.com.
108 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
110 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
111 "A String",
112 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]113 },
114 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]116 "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 "isServing": True or False, # If the DNS queries for the zone will be served.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]118 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]119 "additions": [ # Which ResourceRecordSets to add?
120 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]122 "A String",
123 ],
124 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]125 "name": "A String", # For example, www.example.com.
126 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
128 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
129 "A String",
130 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]131 },
132 ],
133 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
134 }
135
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]137
138Returns:
139 An object of the form:
140
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]142 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
143 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]145 "A String",
146 ],
147 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]148 "name": "A String", # For example, www.example.com.
149 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
151 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
152 "A String",
153 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]154 },
155 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]157 "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 "isServing": True or False, # If the DNS queries for the zone will be served.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]160 "additions": [ # Which ResourceRecordSets to add?
161 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]163 "A String",
164 ],
165 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]166 "name": "A String", # For example, www.example.com.
167 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
169 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
170 "A String",
171 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]172 },
173 ],
174 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
175 }</pre>
176</div>
177
178<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 <code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]180 <pre>Fetch the representation of an existing Change.
181
182Args:
183 project: string, Identifies the project addressed by this request. (required)
184 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
185 changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187
188Returns:
189 An object of the form:
190
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]192 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
193 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]195 "A String",
196 ],
197 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]198 "name": "A String", # For example, www.example.com.
199 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
201 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
202 "A String",
203 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]204 },
205 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]207 "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 "isServing": True or False, # If the DNS queries for the zone will be served.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]209 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]210 "additions": [ # Which ResourceRecordSets to add?
211 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]213 "A String",
214 ],
215 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216 "name": "A String", # For example, www.example.com.
217 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
219 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
220 "A String",
221 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]222 },
223 ],
224 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
225 }</pre>
226</div>
227
228<div class="method">
229 <code class="details" id="list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</code>
230 <pre>Enumerate Changes to a ResourceRecordSet collection.
231
232Args:
233 project: string, Identifies the project addressed by this request. (required)
234 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
235 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
236 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
237 sortBy: string, Sorting criterion. The only supported value is change sequence.
238 Allowed values
239 changeSequence -
240 sortOrder: string, Sorting order direction: 'ascending' or 'descending'.
241
242Returns:
243 An object of the form:
244
245 { # The response to a request to enumerate Changes to a ResourceRecordSets collection.
246 "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.
247 #
248 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "header": { # Elements common to every response.
250 "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).
251 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]252 "kind": "dns#changesListResponse", # Type of resource.
253 "changes": [ # The requested changes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]254 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]255 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
256 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]258 "A String",
259 ],
260 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]261 "name": "A String", # For example, www.example.com.
262 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
264 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
265 "A String",
266 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]267 },
268 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]270 "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "isServing": True or False, # If the DNS queries for the zone will be served.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]272 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]273 "additions": [ # Which ResourceRecordSets to add?
274 { # A unit of data that will be returned by the DNS servers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]276 "A String",
277 ],
278 "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]279 "name": "A String", # For example, www.example.com.
280 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
282 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
283 "A String",
284 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]285 },
286 ],
287 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
288 },
289 ],
290 }</pre>
291</div>
292
293<div class="method">
294 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
295 <pre>Retrieves the next page of results.
296
297Args:
298 previous_request: The request for the previous page. (required)
299 previous_response: The response from the request for the previous page. (required)
300
301Returns:
302 A request object that you can call 'execute()' on to request the next
303 page. Returns None if there are no more items in the collection.
304 </pre>
305</div>
306
307</body></html>