• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
78  <code><a href="#create">create(project, managedZone, body)</a></code></p>
79<p class="firstline">Atomically update the ResourceRecordSet collection.</p>
80<p class="toc_element">
81  <code><a href="#get">get(project, managedZone, changeId)</a></code></p>
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">
91    <code class="details" id="create">create(project, managedZone, body)</code>
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)
97  body: object, The request body. (required)
98    The object takes the form of:
99
100{ # An atomic update to a collection of ResourceRecordSets.
101    "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
102      { # A unit of data that will be returned by the DNS servers.
103        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
104          "A String",
105        ],
106        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
107        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
108        "name": "A String", # For example, www.example.com.
109        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
110      },
111    ],
112    "status": "A String", # Status of the operation (output only).
113    "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
114    "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
115    "additions": [ # Which ResourceRecordSets to add?
116      { # A unit of data that will be returned by the DNS servers.
117        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
118          "A String",
119        ],
120        "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
121        "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
122        "name": "A String", # For example, www.example.com.
123        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
124      },
125    ],
126    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
127  }
128
129
130Returns:
131  An object of the form:
132
133    { # An atomic update to a collection of ResourceRecordSets.
134      "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
135        { # A unit of data that will be returned by the DNS servers.
136          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
137            "A String",
138          ],
139          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
140          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
141          "name": "A String", # For example, www.example.com.
142          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
143        },
144      ],
145      "status": "A String", # Status of the operation (output only).
146      "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
147      "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
148      "additions": [ # Which ResourceRecordSets to add?
149        { # A unit of data that will be returned by the DNS servers.
150          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
151            "A String",
152          ],
153          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
154          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
155          "name": "A String", # For example, www.example.com.
156          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
157        },
158      ],
159      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
160    }</pre>
161</div>
162
163<div class="method">
164    <code class="details" id="get">get(project, managedZone, changeId)</code>
165  <pre>Fetch the representation of an existing Change.
166
167Args:
168  project: string, Identifies the project addressed by this request. (required)
169  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
170  changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)
171
172Returns:
173  An object of the form:
174
175    { # An atomic update to a collection of ResourceRecordSets.
176      "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
177        { # A unit of data that will be returned by the DNS servers.
178          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
179            "A String",
180          ],
181          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
182          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
183          "name": "A String", # For example, www.example.com.
184          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
185        },
186      ],
187      "status": "A String", # Status of the operation (output only).
188      "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
189      "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
190      "additions": [ # Which ResourceRecordSets to add?
191        { # A unit of data that will be returned by the DNS servers.
192          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
193            "A String",
194          ],
195          "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
196          "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
197          "name": "A String", # For example, www.example.com.
198          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
199        },
200      ],
201      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
202    }</pre>
203</div>
204
205<div class="method">
206    <code class="details" id="list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</code>
207  <pre>Enumerate Changes to a ResourceRecordSet collection.
208
209Args:
210  project: string, Identifies the project addressed by this request. (required)
211  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
212  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
213  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
214  sortBy: string, Sorting criterion. The only supported value is change sequence.
215    Allowed values
216      changeSequence -
217  sortOrder: string, Sorting order direction: 'ascending' or 'descending'.
218
219Returns:
220  An object of the form:
221
222    { # The response to a request to enumerate Changes to a ResourceRecordSets collection.
223    "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.
224        #
225        # 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.
226    "kind": "dns#changesListResponse", # Type of resource.
227    "changes": [ # The requested changes.
228      { # An atomic update to a collection of ResourceRecordSets.
229          "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
230            { # A unit of data that will be returned by the DNS servers.
231              "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
232                "A String",
233              ],
234              "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
235              "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
236              "name": "A String", # For example, www.example.com.
237              "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
238            },
239          ],
240          "status": "A String", # Status of the operation (output only).
241          "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
242          "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
243          "additions": [ # Which ResourceRecordSets to add?
244            { # A unit of data that will be returned by the DNS servers.
245              "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
246                "A String",
247              ],
248              "kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
249              "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
250              "name": "A String", # For example, www.example.com.
251              "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
252            },
253          ],
254          "id": "A String", # Unique identifier for the resource; defined by the server (output only).
255        },
256    ],
257  }</pre>
258</div>
259
260<div class="method">
261    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
262  <pre>Retrieves the next page of results.
263
264Args:
265  previous_request: The request for the previous page. (required)
266  previous_response: The response from the request for the previous page. (required)
267
268Returns:
269  A request object that you can call 'execute()' on to request the next
270  page. Returns None if there are no more items in the collection.
271    </pre>
272</div>
273
274</body></html>