blob: b6be52056088cd186d666eb8c36e104f9c619ee7 [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
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.changes.html">changes</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Atomically update the ResourceRecordSet collection.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000083<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#get">get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Fetch the representation of an existing Change.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000086<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080087 <code><a href="#list">list(project, managedZone, maxResults=None, sortBy=None, pageToken=None, sortOrder=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070088<p class="firstline">Enumerate Changes to a ResourceRecordSet collection.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070099 <code class="details" id="create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
100 <pre>Atomically update the ResourceRecordSet collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000101
102Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700103 project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700104 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 -0700105 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000106 The object takes the form of:
107
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108{ # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800109 &quot;additions&quot;: [ # Which ResourceRecordSets to add?
110 { # A unit of data that will be returned by the DNS servers.
111 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
112 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
113 &quot;wrrPolicy&quot;: {
114 &quot;items&quot;: [
115 {
116 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
117 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
118 &quot;A String&quot;,
119 ],
120 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
121 &quot;rrdatas&quot;: [
122 &quot;A String&quot;,
123 ],
124 },
125 ],
126 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700127 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800128 &quot;geoPolicy&quot;: {
129 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
130 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
131 {
132 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
133 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
134 &quot;rrdatas&quot;: [
135 &quot;A String&quot;,
136 ],
137 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
138 &quot;A String&quot;,
139 ],
140 },
141 ],
142 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
143 {
144 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
145 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
146 &quot;rrdatas&quot;: [
147 &quot;A String&quot;,
148 ],
149 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
150 &quot;A String&quot;,
151 ],
152 },
153 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700154 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800155 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700156 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800157 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
158 &quot;A String&quot;,
159 ],
160 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
161 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
162 &quot;A String&quot;,
163 ],
164 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
165 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
166 },
167 ],
168 &quot;deletions&quot;: [ # Which ResourceRecordSets to remove? Must match existing data exactly.
169 { # A unit of data that will be returned by the DNS servers.
170 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
171 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
172 &quot;wrrPolicy&quot;: {
173 &quot;items&quot;: [
174 {
175 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
176 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
177 &quot;A String&quot;,
178 ],
179 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
180 &quot;rrdatas&quot;: [
181 &quot;A String&quot;,
182 ],
183 },
184 ],
185 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
186 },
187 &quot;geoPolicy&quot;: {
188 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
189 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
190 {
191 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
192 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
193 &quot;rrdatas&quot;: [
194 &quot;A String&quot;,
195 ],
196 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
197 &quot;A String&quot;,
198 ],
199 },
200 ],
201 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
202 {
203 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
204 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
205 &quot;rrdatas&quot;: [
206 &quot;A String&quot;,
207 ],
208 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
209 &quot;A String&quot;,
210 ],
211 },
212 ],
213 },
214 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
215 },
216 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
217 &quot;A String&quot;,
218 ],
219 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
220 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
221 &quot;A String&quot;,
222 ],
223 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
224 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
225 },
226 ],
227 &quot;isServing&quot;: True or False, # If the DNS queries for the zone will be served.
228 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
229 &quot;startTime&quot;: &quot;A String&quot;, # The time that this operation was started by the server (output only). This is in RFC3339 text format.
230 &quot;kind&quot;: &quot;dns#change&quot;,
231 &quot;status&quot;: &quot;A String&quot;, # Status of the operation (output only). A status of &quot;done&quot; means that the request to update the authoritative servers has been sent but the servers might not be updated yet.
232}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700233
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240Returns:
241 An object of the form:
242
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700243 { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800244 &quot;additions&quot;: [ # Which ResourceRecordSets to add?
245 { # A unit of data that will be returned by the DNS servers.
246 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
247 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
248 &quot;wrrPolicy&quot;: {
249 &quot;items&quot;: [
250 {
251 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
252 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
253 &quot;A String&quot;,
254 ],
255 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
256 &quot;rrdatas&quot;: [
257 &quot;A String&quot;,
258 ],
259 },
260 ],
261 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700262 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800263 &quot;geoPolicy&quot;: {
264 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
265 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
266 {
267 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
268 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
269 &quot;rrdatas&quot;: [
270 &quot;A String&quot;,
271 ],
272 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
273 &quot;A String&quot;,
274 ],
275 },
276 ],
277 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
278 {
279 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
280 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
281 &quot;rrdatas&quot;: [
282 &quot;A String&quot;,
283 ],
284 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
285 &quot;A String&quot;,
286 ],
287 },
288 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700289 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800290 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700291 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800292 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
293 &quot;A String&quot;,
294 ],
295 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
296 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
297 &quot;A String&quot;,
298 ],
299 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
300 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
301 },
302 ],
303 &quot;deletions&quot;: [ # Which ResourceRecordSets to remove? Must match existing data exactly.
304 { # A unit of data that will be returned by the DNS servers.
305 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
306 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
307 &quot;wrrPolicy&quot;: {
308 &quot;items&quot;: [
309 {
310 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
311 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
312 &quot;A String&quot;,
313 ],
314 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
315 &quot;rrdatas&quot;: [
316 &quot;A String&quot;,
317 ],
318 },
319 ],
320 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
321 },
322 &quot;geoPolicy&quot;: {
323 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
324 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
325 {
326 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
327 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
328 &quot;rrdatas&quot;: [
329 &quot;A String&quot;,
330 ],
331 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
332 &quot;A String&quot;,
333 ],
334 },
335 ],
336 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
337 {
338 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
339 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
340 &quot;rrdatas&quot;: [
341 &quot;A String&quot;,
342 ],
343 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
344 &quot;A String&quot;,
345 ],
346 },
347 ],
348 },
349 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
350 },
351 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
352 &quot;A String&quot;,
353 ],
354 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
355 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
356 &quot;A String&quot;,
357 ],
358 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
359 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
360 },
361 ],
362 &quot;isServing&quot;: True or False, # If the DNS queries for the zone will be served.
363 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
364 &quot;startTime&quot;: &quot;A String&quot;, # The time that this operation was started by the server (output only). This is in RFC3339 text format.
365 &quot;kind&quot;: &quot;dns#change&quot;,
366 &quot;status&quot;: &quot;A String&quot;, # Status of the operation (output only). A status of &quot;done&quot; means that the request to update the authoritative servers has been sent but the servers might not be updated yet.
367 }</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700368</div>
369
370<div class="method">
371 <code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)</code>
372 <pre>Fetch the representation of an existing Change.
373
374Args:
375 project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700376 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700377 changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)
378 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700379 x__xgafv: string, V1 error format.
380 Allowed values
381 1 - v1 error format
382 2 - v2 error format
383
384Returns:
385 An object of the form:
386
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700387 { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800388 &quot;additions&quot;: [ # Which ResourceRecordSets to add?
389 { # A unit of data that will be returned by the DNS servers.
390 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
391 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
392 &quot;wrrPolicy&quot;: {
393 &quot;items&quot;: [
394 {
395 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
396 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
397 &quot;A String&quot;,
398 ],
399 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
400 &quot;rrdatas&quot;: [
401 &quot;A String&quot;,
402 ],
403 },
404 ],
405 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700406 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800407 &quot;geoPolicy&quot;: {
408 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
409 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
410 {
411 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
412 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
413 &quot;rrdatas&quot;: [
414 &quot;A String&quot;,
415 ],
416 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
417 &quot;A String&quot;,
418 ],
419 },
420 ],
421 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
422 {
423 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
424 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
425 &quot;rrdatas&quot;: [
426 &quot;A String&quot;,
427 ],
428 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
429 &quot;A String&quot;,
430 ],
431 },
432 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700433 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800434 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700435 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800436 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
437 &quot;A String&quot;,
438 ],
439 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
440 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
441 &quot;A String&quot;,
442 ],
443 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
444 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
445 },
446 ],
447 &quot;deletions&quot;: [ # Which ResourceRecordSets to remove? Must match existing data exactly.
448 { # A unit of data that will be returned by the DNS servers.
449 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
450 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
451 &quot;wrrPolicy&quot;: {
452 &quot;items&quot;: [
453 {
454 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
455 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
456 &quot;A String&quot;,
457 ],
458 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
459 &quot;rrdatas&quot;: [
460 &quot;A String&quot;,
461 ],
462 },
463 ],
464 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
465 },
466 &quot;geoPolicy&quot;: {
467 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
468 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
469 {
470 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
471 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
472 &quot;rrdatas&quot;: [
473 &quot;A String&quot;,
474 ],
475 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
476 &quot;A String&quot;,
477 ],
478 },
479 ],
480 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
481 {
482 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
483 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
484 &quot;rrdatas&quot;: [
485 &quot;A String&quot;,
486 ],
487 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
488 &quot;A String&quot;,
489 ],
490 },
491 ],
492 },
493 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
494 },
495 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
496 &quot;A String&quot;,
497 ],
498 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
499 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
500 &quot;A String&quot;,
501 ],
502 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
503 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
504 },
505 ],
506 &quot;isServing&quot;: True or False, # If the DNS queries for the zone will be served.
507 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
508 &quot;startTime&quot;: &quot;A String&quot;, # The time that this operation was started by the server (output only). This is in RFC3339 text format.
509 &quot;kind&quot;: &quot;dns#change&quot;,
510 &quot;status&quot;: &quot;A String&quot;, # Status of the operation (output only). A status of &quot;done&quot; means that the request to update the authoritative servers has been sent but the servers might not be updated yet.
511 }</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700512</div>
513
514<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800515 <code class="details" id="list">list(project, managedZone, maxResults=None, sortBy=None, pageToken=None, sortOrder=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700516 <pre>Enumerate Changes to a ResourceRecordSet collection.
517
518Args:
519 project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700520 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800521 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700522 sortBy: string, Sorting criterion. The only supported value is change sequence.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700523 Allowed values
524 changeSequence -
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800525 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800526 sortOrder: string, Sorting order direction: &#x27;ascending&#x27; or &#x27;descending&#x27;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700527 x__xgafv: string, V1 error format.
528 Allowed values
529 1 - v1 error format
530 2 - v2 error format
531
532Returns:
533 An object of the form:
534
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700535 { # The response to a request to enumerate Changes to a ResourceRecordSets collection.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800536 &quot;kind&quot;: &quot;dns#changesListResponse&quot;, # Type of resource.
537 &quot;changes&quot;: [ # The requested changes.
538 { # 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.
539 &quot;additions&quot;: [ # Which ResourceRecordSets to add?
540 { # A unit of data that will be returned by the DNS servers.
541 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
542 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
543 &quot;wrrPolicy&quot;: {
544 &quot;items&quot;: [
545 {
546 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
547 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
548 &quot;A String&quot;,
549 ],
550 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
551 &quot;rrdatas&quot;: [
552 &quot;A String&quot;,
553 ],
554 },
555 ],
556 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
557 },
558 &quot;geoPolicy&quot;: {
559 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
560 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
561 {
562 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
563 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
564 &quot;rrdatas&quot;: [
565 &quot;A String&quot;,
566 ],
567 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
568 &quot;A String&quot;,
569 ],
570 },
571 ],
572 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
573 {
574 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
575 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
576 &quot;rrdatas&quot;: [
577 &quot;A String&quot;,
578 ],
579 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
580 &quot;A String&quot;,
581 ],
582 },
583 ],
584 },
585 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
586 },
587 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
588 &quot;A String&quot;,
589 ],
590 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
591 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
592 &quot;A String&quot;,
593 ],
594 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
595 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
596 },
597 ],
598 &quot;deletions&quot;: [ # Which ResourceRecordSets to remove? Must match existing data exactly.
599 { # A unit of data that will be returned by the DNS servers.
600 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
601 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise.
602 &quot;wrrPolicy&quot;: {
603 &quot;items&quot;: [
604 {
605 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
606 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above wrr_rrdata.
607 &quot;A String&quot;,
608 ],
609 &quot;weight&quot;: 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].
610 &quot;rrdatas&quot;: [
611 &quot;A String&quot;,
612 ],
613 },
614 ],
615 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
616 },
617 &quot;geoPolicy&quot;: {
618 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
619 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
620 {
621 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
622 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
623 &quot;rrdatas&quot;: [
624 &quot;A String&quot;,
625 ],
626 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
627 &quot;A String&quot;,
628 ],
629 },
630 ],
631 &quot;failovers&quot;: [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won&#x27;t be healthchecked - we&#x27;ll return the primarily configured rrdata irrespective of whether it is healthy or not.
632 {
633 &quot;location&quot;: &quot;A String&quot;, # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g &quot;us-east1&quot;, &quot;southamerica-east1&quot;, &quot;asia-east1&quot;, etc.
634 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
635 &quot;rrdatas&quot;: [
636 &quot;A String&quot;,
637 ],
638 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for the above geo_rrdata.
639 &quot;A String&quot;,
640 ],
641 },
642 ],
643 },
644 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
645 },
646 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
647 &quot;A String&quot;,
648 ],
649 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
650 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
651 &quot;A String&quot;,
652 ],
653 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
654 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
655 },
656 ],
657 &quot;isServing&quot;: True or False, # If the DNS queries for the zone will be served.
658 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
659 &quot;startTime&quot;: &quot;A String&quot;, # The time that this operation was started by the server (output only). This is in RFC3339 text format.
660 &quot;kind&quot;: &quot;dns#change&quot;,
661 &quot;status&quot;: &quot;A String&quot;, # Status of the operation (output only). A status of &quot;done&quot; means that the request to update the authoritative servers has been sent but the servers might not be updated yet.
662 },
663 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700664 &quot;header&quot;: { # Elements common to every response.
665 &quot;operationId&quot;: &quot;A String&quot;, # 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).
666 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800667 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &quot;snapshot&quot; of collections larger than the maximum page size.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000668 }</pre>
669</div>
670
671<div class="method">
672 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
673 <pre>Retrieves the next page of results.
674
675Args:
676 previous_request: The request for the previous page. (required)
677 previous_response: The response from the request for the previous page. (required)
678
679Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700680 A request object that you can call &#x27;execute()&#x27; on to request the next
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000681 page. Returns None if there are no more items in the collection.
682 </pre>
683</div>
684
685</body></html>