Debian Codegraph @

docs/dyn/dns_v2.responsePolicyRules.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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_v2.html">Cloud DNS API</a> . <a href="dns_v2.responsePolicyRules.html">responsePolicyRules</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(project, location, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new Response Policy Rule.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(project, location, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a previously created Response Policy Rule.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(project, location, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Fetches the representation of an existing Response Policy Rule.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, location, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Enumerates all Response Policy Rules associated with a project.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(project, location, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Applies a partial update to an existing Response Policy Rule.</p>
98 <p class="toc_element">
99 <code><a href="#update">update(project, location, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Updates an existing Response Policy Rule.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="create">create(project, location, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
109 <pre>Creates a new Response Policy Rule.
110
111 Args:
112 project: string, Identifies the project addressed by this request. (required)
113 location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
114 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
115 body: object, The request body.
116 The object takes the form of:
117
118 { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
119 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
120 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
121 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
122 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
123 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
124 { # A unit of data that is returned by the DNS servers.
125 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
126 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
127 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
128 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
129 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
130 { # ResourceRecordSet data for one geo location.
131 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
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;rrdatas&quot;: [
134 &quot;A String&quot;,
135 ],
136 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
137 &quot;A String&quot;,
138 ],
139 },
140 ],
141 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
142 },
143 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
144 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
145 &quot;items&quot;: [
146 { # A routing block which contains the routing information for one WRR item.
147 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
148 &quot;rrdatas&quot;: [
149 &quot;A String&quot;,
150 ],
151 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
152 &quot;A String&quot;,
153 ],
154 &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 non-negative.
155 },
156 ],
157 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
158 },
159 },
160 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
161 &quot;A String&quot;,
162 ],
163 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
164 &quot;A String&quot;,
165 ],
166 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
167 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
168 },
169 ],
170 },
171 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
172 }
173
174 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180 Returns:
181 An object of the form:
182
183 { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
184 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
185 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
186 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
187 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
188 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
189 { # A unit of data that is returned by the DNS servers.
190 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
191 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
192 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
193 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
194 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
195 { # ResourceRecordSet data for one geo location.
196 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
197 &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.
198 &quot;rrdatas&quot;: [
199 &quot;A String&quot;,
200 ],
201 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
202 &quot;A String&quot;,
203 ],
204 },
205 ],
206 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
207 },
208 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
209 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
210 &quot;items&quot;: [
211 { # A routing block which contains the routing information for one WRR item.
212 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
213 &quot;rrdatas&quot;: [
214 &quot;A String&quot;,
215 ],
216 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
217 &quot;A String&quot;,
218 ],
219 &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 non-negative.
220 },
221 ],
222 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
223 },
224 },
225 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
226 &quot;A String&quot;,
227 ],
228 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
229 &quot;A String&quot;,
230 ],
231 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
232 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
233 },
234 ],
235 },
236 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
237 }</pre>
238 </div>
239
240 <div class="method">
241 <code class="details" id="delete">delete(project, location, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</code>
242 <pre>Deletes a previously created Response Policy Rule.
243
244 Args:
245 project: string, Identifies the project addressed by this request. (required)
246 location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
247 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
248 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
249 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
250 x__xgafv: string, V1 error format.
251 Allowed values
252 1 - v1 error format
253 2 - v2 error format
254 </pre>
255 </div>
256
257 <div class="method">
258 <code class="details" id="get">get(project, location, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</code>
259 <pre>Fetches the representation of an existing Response Policy Rule.
260
261 Args:
262 project: string, Identifies the project addressed by this request. (required)
263 location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
264 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
265 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
266 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
267 x__xgafv: string, V1 error format.
268 Allowed values
269 1 - v1 error format
270 2 - v2 error format
271
272 Returns:
273 An object of the form:
274
275 { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
276 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
277 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
278 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
279 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
280 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
281 { # A unit of data that is returned by the DNS servers.
282 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
283 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
284 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
285 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
286 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
287 { # ResourceRecordSet data for one geo location.
288 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
289 &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.
290 &quot;rrdatas&quot;: [
291 &quot;A String&quot;,
292 ],
293 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
294 &quot;A String&quot;,
295 ],
296 },
297 ],
298 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
299 },
300 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
301 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
302 &quot;items&quot;: [
303 { # A routing block which contains the routing information for one WRR item.
304 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
305 &quot;rrdatas&quot;: [
306 &quot;A String&quot;,
307 ],
308 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
309 &quot;A String&quot;,
310 ],
311 &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 non-negative.
312 },
313 ],
314 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
315 },
316 },
317 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
318 &quot;A String&quot;,
319 ],
320 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
321 &quot;A String&quot;,
322 ],
323 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
324 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
325 },
326 ],
327 },
328 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
329 }</pre>
330 </div>
331
332 <div class="method">
333 <code class="details" id="list">list(project, location, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)</code>
334 <pre>Enumerates all Response Policy Rules associated with a project.
335
336 Args:
337 project: string, Identifies the project addressed by this request. (required)
338 location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
339 responsePolicy: string, User assigned name of the Response Policy to list. (required)
340 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
341 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
346
347 Returns:
348 An object of the form:
349
350 {
351 &quot;header&quot;: { # Elements common to every response.
352 &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).
353 },
354 &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 page token. This lets you 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
355 &quot;responsePolicyRules&quot;: [ # The Response Policy Rule resources.
356 { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
357 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
358 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
359 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
360 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
361 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
362 { # A unit of data that is returned by the DNS servers.
363 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
364 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
365 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
366 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
367 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
368 { # ResourceRecordSet data for one geo location.
369 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
370 &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.
371 &quot;rrdatas&quot;: [
372 &quot;A String&quot;,
373 ],
374 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
375 &quot;A String&quot;,
376 ],
377 },
378 ],
379 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
380 },
381 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
382 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
383 &quot;items&quot;: [
384 { # A routing block which contains the routing information for one WRR item.
385 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
386 &quot;rrdatas&quot;: [
387 &quot;A String&quot;,
388 ],
389 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
390 &quot;A String&quot;,
391 ],
392 &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 non-negative.
393 },
394 ],
395 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
396 },
397 },
398 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
399 &quot;A String&quot;,
400 ],
401 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
402 &quot;A String&quot;,
403 ],
404 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
405 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
406 },
407 ],
408 },
409 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
410 },
411 ],
412 }</pre>
413 </div>
414
415 <div class="method">
416 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
417 <pre>Retrieves the next page of results.
418
419 Args:
420 previous_request: The request for the previous page. (required)
421 previous_response: The response from the request for the previous page. (required)
422
423 Returns:
424 A request object that you can call &#x27;execute()&#x27; on to request the next
425 page. Returns None if there are no more items in the collection.
426 </pre>
427 </div>
428
429 <div class="method">
430 <code class="details" id="patch">patch(project, location, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</code>
431 <pre>Applies a partial update to an existing Response Policy Rule.
432
433 Args:
434 project: string, Identifies the project addressed by this request. (required)
435 location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
436 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
437 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
438 body: object, The request body.
439 The object takes the form of:
440
441 { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
442 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
443 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
444 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
445 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
446 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
447 { # A unit of data that is returned by the DNS servers.
448 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
449 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
450 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
452 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
453 { # ResourceRecordSet data for one geo location.
454 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
455 &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.
456 &quot;rrdatas&quot;: [
457 &quot;A String&quot;,
458 ],
459 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
460 &quot;A String&quot;,
461 ],
462 },
463 ],
464 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
465 },
466 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
467 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
468 &quot;items&quot;: [
469 { # A routing block which contains the routing information for one WRR item.
470 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
471 &quot;rrdatas&quot;: [
472 &quot;A String&quot;,
473 ],
474 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
475 &quot;A String&quot;,
476 ],
477 &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 non-negative.
478 },
479 ],
480 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
481 },
482 },
483 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
484 &quot;A String&quot;,
485 ],
486 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
487 &quot;A String&quot;,
488 ],
489 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
490 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
491 },
492 ],
493 },
494 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
495 }
496
497 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
498 x__xgafv: string, V1 error format.
499 Allowed values
500 1 - v1 error format
501 2 - v2 error format
502
503 Returns:
504 An object of the form:
505
506 {
507 &quot;header&quot;: { # Elements common to every response.
508 &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).
509 },
510 &quot;responsePolicyRule&quot;: { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
511 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
512 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
513 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
514 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
515 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
516 { # A unit of data that is returned by the DNS servers.
517 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
518 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
519 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
520 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
521 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
522 { # ResourceRecordSet data for one geo location.
523 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
524 &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.
525 &quot;rrdatas&quot;: [
526 &quot;A String&quot;,
527 ],
528 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
529 &quot;A String&quot;,
530 ],
531 },
532 ],
533 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
534 },
535 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
536 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
537 &quot;items&quot;: [
538 { # A routing block which contains the routing information for one WRR item.
539 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
540 &quot;rrdatas&quot;: [
541 &quot;A String&quot;,
542 ],
543 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
544 &quot;A String&quot;,
545 ],
546 &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 non-negative.
547 },
548 ],
549 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
550 },
551 },
552 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
553 &quot;A String&quot;,
554 ],
555 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
556 &quot;A String&quot;,
557 ],
558 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
559 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
560 },
561 ],
562 },
563 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
564 },
565 }</pre>
566 </div>
567
568 <div class="method">
569 <code class="details" id="update">update(project, location, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</code>
570 <pre>Updates an existing Response Policy Rule.
571
572 Args:
573 project: string, Identifies the project addressed by this request. (required)
574 location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
575 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
576 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
577 body: object, The request body.
578 The object takes the form of:
579
580 { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
581 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
582 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
583 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
584 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
585 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
586 { # A unit of data that is returned by the DNS servers.
587 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
588 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
589 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
590 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
591 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
592 { # ResourceRecordSet data for one geo location.
593 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
594 &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.
595 &quot;rrdatas&quot;: [
596 &quot;A String&quot;,
597 ],
598 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
599 &quot;A String&quot;,
600 ],
601 },
602 ],
603 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
604 },
605 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
606 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
607 &quot;items&quot;: [
608 { # A routing block which contains the routing information for one WRR item.
609 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
610 &quot;rrdatas&quot;: [
611 &quot;A String&quot;,
612 ],
613 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
614 &quot;A String&quot;,
615 ],
616 &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 non-negative.
617 },
618 ],
619 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
620 },
621 },
622 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
623 &quot;A String&quot;,
624 ],
625 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
626 &quot;A String&quot;,
627 ],
628 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
629 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
630 },
631 ],
632 },
633 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
634 }
635
636 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
637 x__xgafv: string, V1 error format.
638 Allowed values
639 1 - v1 error format
640 2 - v2 error format
641
642 Returns:
643 An object of the form:
644
645 {
646 &quot;header&quot;: { # Elements common to every response.
647 &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).
648 },
649 &quot;responsePolicyRule&quot;: { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
650 &quot;behavior&quot;: &quot;A String&quot;, # Answer this query with a behavior rather than DNS data.
651 &quot;dnsName&quot;: &quot;A String&quot;, # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
652 &quot;kind&quot;: &quot;dns#responsePolicyRule&quot;,
653 &quot;localData&quot;: { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
654 &quot;localDatas&quot;: [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
655 { # A unit of data that is returned by the DNS servers.
656 &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
657 &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
658 &quot;routingPolicy&quot;: { # A RRSetRoutingPolicy represents ResourceRecordSet data that is 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.
659 &quot;geo&quot;: { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
660 &quot;items&quot;: [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
661 { # ResourceRecordSet data for one geo location.
662 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem&quot;,
663 &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.
664 &quot;rrdatas&quot;: [
665 &quot;A String&quot;,
666 ],
667 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
668 &quot;A String&quot;,
669 ],
670 },
671 ],
672 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyGeoPolicy&quot;,
673 },
674 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicy&quot;,
675 &quot;wrr&quot;: { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
676 &quot;items&quot;: [
677 { # A routing block which contains the routing information for one WRR item.
678 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem&quot;,
679 &quot;rrdatas&quot;: [
680 &quot;A String&quot;,
681 ],
682 &quot;signatureRrdatas&quot;: [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there&#x27;s a restriction of 1 ip per item. .
683 &quot;A String&quot;,
684 ],
685 &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 non-negative.
686 },
687 ],
688 &quot;kind&quot;: &quot;dns#rRSetRoutingPolicyWrrPolicy&quot;,
689 },
690 },
691 &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
692 &quot;A String&quot;,
693 ],
694 &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
695 &quot;A String&quot;,
696 ],
697 &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
698 &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
699 },
700 ],
701 },
702 &quot;ruleName&quot;: &quot;A String&quot;, # An identifier for this rule. Must be unique with the ResponsePolicy.
703 },
704 }</pre>
705 </div>
706
707 </body></html>