blob: ed17263cbd2c412aa040a230028014b09acbe65e [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001<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 -070078 <code><a href="#create">create(project, managedZone, body=None, clientOperationId=None)</a></code></p>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070079<p class="firstline"></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000080<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <code><a href="#get">get(project, managedZone, changeId, clientOperationId=None)</a></code></p>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070082<p class="firstline"></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000083<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070084 <code><a href="#list">list(project, managedZone, maxResults=None, pageToken=None, sortBy=None, sortOrder=None)</a></code></p>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070085<p class="firstline"></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000086<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 -070091 <code class="details" id="create">create(project, managedZone, body=None, clientOperationId=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070092 <pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000093
94Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070095 project: string, A parameter (required)
96 managedZone: string, A parameter (required)
Dan O'Mearadd494642020-05-01 07:42:23 -070097 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +000098 The object takes the form of:
99
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700100{
101 &quot;additions&quot;: [
102 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700103 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700104 &quot;name&quot;: &quot;A String&quot;,
105 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000107 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700108 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700110 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700111 &quot;ttl&quot;: 42,
112 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000113 },
114 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700115 &quot;deletions&quot;: [
116 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700118 &quot;name&quot;: &quot;A String&quot;,
119 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000121 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700122 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700125 &quot;ttl&quot;: 42,
126 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000127 },
128 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700129 &quot;id&quot;: &quot;A String&quot;,
130 &quot;isServing&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700131 &quot;kind&quot;: &quot;dns#change&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#change&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700132 &quot;startTime&quot;: &quot;A String&quot;,
133 &quot;status&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000134 }
135
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700136 clientOperationId: string, A parameter
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000137
138Returns:
139 An object of the form:
140
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700141 {
142 &quot;additions&quot;: [
143 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700145 &quot;name&quot;: &quot;A String&quot;,
146 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700147 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000148 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700149 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700152 &quot;ttl&quot;: 42,
153 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000154 },
155 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700156 &quot;deletions&quot;: [
157 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700159 &quot;name&quot;: &quot;A String&quot;,
160 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000162 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700163 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700164 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700165 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700166 &quot;ttl&quot;: 42,
167 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000168 },
169 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700170 &quot;id&quot;: &quot;A String&quot;,
171 &quot;isServing&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700172 &quot;kind&quot;: &quot;dns#change&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#change&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700173 &quot;startTime&quot;: &quot;A String&quot;,
174 &quot;status&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000175 }</pre>
176</div>
177
178<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700179 <code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700180 <pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000181
182Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700183 project: string, A parameter (required)
184 managedZone: string, A parameter (required)
185 changeId: string, A parameter (required)
186 clientOperationId: string, A parameter
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000187
188Returns:
189 An object of the form:
190
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700191 {
192 &quot;additions&quot;: [
193 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700195 &quot;name&quot;: &quot;A String&quot;,
196 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000198 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700199 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700202 &quot;ttl&quot;: 42,
203 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000204 },
205 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700206 &quot;deletions&quot;: [
207 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700208 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700209 &quot;name&quot;: &quot;A String&quot;,
210 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700211 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000212 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700213 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700215 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700216 &quot;ttl&quot;: 42,
217 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000218 },
219 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700220 &quot;id&quot;: &quot;A String&quot;,
221 &quot;isServing&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700222 &quot;kind&quot;: &quot;dns#change&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#change&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700223 &quot;startTime&quot;: &quot;A String&quot;,
224 &quot;status&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000225 }</pre>
226</div>
227
228<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700229 <code class="details" id="list">list(project, managedZone, maxResults=None, pageToken=None, sortBy=None, sortOrder=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700230 <pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000231
232Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700233 project: string, A parameter (required)
234 managedZone: string, A parameter (required)
235 maxResults: integer, A parameter
236 pageToken: string, A parameter
237 sortBy: string, A parameter
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000238 Allowed values
239 changeSequence -
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700240 sortOrder: string, A parameter
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000241
242Returns:
243 An object of the form:
244
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700245 {
246 &quot;changes&quot;: [
247 {
248 &quot;additions&quot;: [
249 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700250 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700251 &quot;name&quot;: &quot;A String&quot;,
252 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000254 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700255 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700256 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700257 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700258 &quot;ttl&quot;: 42,
259 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000260 },
261 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700262 &quot;deletions&quot;: [
263 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700264 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#resourceRecordSet&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700265 &quot;name&quot;: &quot;A String&quot;,
266 &quot;rrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000268 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700269 &quot;signatureRrdatas&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700270 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700271 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700272 &quot;ttl&quot;: 42,
273 &quot;type&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000274 },
275 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700276 &quot;id&quot;: &quot;A String&quot;,
277 &quot;isServing&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 &quot;kind&quot;: &quot;dns#change&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#change&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700279 &quot;startTime&quot;: &quot;A String&quot;,
280 &quot;status&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000281 },
282 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700283 &quot;header&quot;: {
284 &quot;operationId&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700285 },
286 &quot;kind&quot;: &quot;dns#changesListResponse&quot;, # Type of resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700287 &quot;nextPageToken&quot;: &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000288 }</pre>
289</div>
290
291<div class="method">
292 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
293 <pre>Retrieves the next page of results.
294
295Args:
296 previous_request: The request for the previous page. (required)
297 previous_response: The response from the request for the previous page. (required)
298
299Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700300 A request object that you can call &#x27;execute()&#x27; on to request the next
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000301 page. Returns None if there are no more items in the collection.
302 </pre>
303</div>
304
305</body></html>