| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.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, 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, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 85 | <p class="firstline">Deletes a previously created Response Policy Rule.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 88 | <p class="firstline">Fetches the representation of an existing Response Policy Rule.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(project, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 91 | <p class="firstline">Enumerates all Response Policy Rules associated with a project.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 97 | <p class="firstline">Applies a partial update to an existing Response Policy Rule.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 98 | <p class="toc_element"> |
| 99 | <code><a href="#update">update(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 100 | <p class="firstline">Updates an existing Response Policy Rule.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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, 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 | responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) |
| 114 | body: object, The request body. |
| 115 | The object takes the form of: |
| 116 | |
| 117 | { # 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. |
| 118 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 119 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 120 | "kind": "dns#responsePolicyRule", |
| 121 | "localData": { # 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. |
| 122 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 123 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 124 | "kind": "dns#resourceRecordSet", |
| 125 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 126 | "routingPolicy": { # 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. |
| 127 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 128 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 129 | { |
| 130 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 131 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 132 | "rrdatas": [ |
| 133 | "A String", |
| 134 | ], |
| 135 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 136 | "A String", |
| 137 | ], |
| 138 | }, |
| 139 | ], |
| 140 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 141 | }, |
| 142 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 143 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 144 | { |
| 145 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 146 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 147 | "rrdatas": [ |
| 148 | "A String", |
| 149 | ], |
| 150 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 151 | "A String", |
| 152 | ], |
| 153 | }, |
| 154 | ], |
| 155 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 156 | }, |
| 157 | "kind": "dns#rRSetRoutingPolicy", |
| 158 | "wrr": { |
| 159 | "items": [ |
| 160 | { |
| 161 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 162 | "rrdatas": [ |
| 163 | "A String", |
| 164 | ], |
| 165 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 166 | "A String", |
| 167 | ], |
| 168 | "weight": 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. |
| 169 | }, |
| 170 | ], |
| 171 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 172 | }, |
| 173 | "wrrPolicy": { |
| 174 | "items": [ |
| 175 | { |
| 176 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 177 | "rrdatas": [ |
| 178 | "A String", |
| 179 | ], |
| 180 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 181 | "A String", |
| 182 | ], |
| 183 | "weight": 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. |
| 184 | }, |
| 185 | ], |
| 186 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 187 | }, |
| 188 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 189 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 190 | "A String", |
| 191 | ], |
| 192 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 193 | "A String", |
| 194 | ], |
| 195 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 196 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 197 | }, |
| 198 | ], |
| 199 | }, |
| 200 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 201 | } |
| 202 | |
| 203 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 204 | x__xgafv: string, V1 error format. |
| 205 | Allowed values |
| 206 | 1 - v1 error format |
| 207 | 2 - v2 error format |
| 208 | |
| 209 | Returns: |
| 210 | An object of the form: |
| 211 | |
| 212 | { # 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. |
| 213 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 214 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 215 | "kind": "dns#responsePolicyRule", |
| 216 | "localData": { # 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. |
| 217 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 218 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 219 | "kind": "dns#resourceRecordSet", |
| 220 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 221 | "routingPolicy": { # 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. |
| 222 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 223 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 224 | { |
| 225 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 226 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 227 | "rrdatas": [ |
| 228 | "A String", |
| 229 | ], |
| 230 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 231 | "A String", |
| 232 | ], |
| 233 | }, |
| 234 | ], |
| 235 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 236 | }, |
| 237 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 238 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 239 | { |
| 240 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 241 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 242 | "rrdatas": [ |
| 243 | "A String", |
| 244 | ], |
| 245 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 246 | "A String", |
| 247 | ], |
| 248 | }, |
| 249 | ], |
| 250 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 251 | }, |
| 252 | "kind": "dns#rRSetRoutingPolicy", |
| 253 | "wrr": { |
| 254 | "items": [ |
| 255 | { |
| 256 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 257 | "rrdatas": [ |
| 258 | "A String", |
| 259 | ], |
| 260 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 261 | "A String", |
| 262 | ], |
| 263 | "weight": 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. |
| 264 | }, |
| 265 | ], |
| 266 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 267 | }, |
| 268 | "wrrPolicy": { |
| 269 | "items": [ |
| 270 | { |
| 271 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 272 | "rrdatas": [ |
| 273 | "A String", |
| 274 | ], |
| 275 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 276 | "A String", |
| 277 | ], |
| 278 | "weight": 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. |
| 279 | }, |
| 280 | ], |
| 281 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 282 | }, |
| 283 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 284 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 285 | "A String", |
| 286 | ], |
| 287 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 288 | "A String", |
| 289 | ], |
| 290 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 291 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 292 | }, |
| 293 | ], |
| 294 | }, |
| 295 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 296 | }</pre> |
| 297 | </div> |
| 298 | |
| 299 | <div class="method"> |
| 300 | <code class="details" id="delete">delete(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 301 | <pre>Deletes a previously created Response Policy Rule. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 302 | |
| 303 | Args: |
| 304 | project: string, Identifies the project addressed by this request. (required) |
| 305 | responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) |
| 306 | responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) |
| 307 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 308 | x__xgafv: string, V1 error format. |
| 309 | Allowed values |
| 310 | 1 - v1 error format |
| 311 | 2 - v2 error format |
| 312 | </pre> |
| 313 | </div> |
| 314 | |
| 315 | <div class="method"> |
| 316 | <code class="details" id="get">get(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 317 | <pre>Fetches the representation of an existing Response Policy Rule. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 318 | |
| 319 | Args: |
| 320 | project: string, Identifies the project addressed by this request. (required) |
| 321 | responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) |
| 322 | responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) |
| 323 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 324 | x__xgafv: string, V1 error format. |
| 325 | Allowed values |
| 326 | 1 - v1 error format |
| 327 | 2 - v2 error format |
| 328 | |
| 329 | Returns: |
| 330 | An object of the form: |
| 331 | |
| 332 | { # 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. |
| 333 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 334 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 335 | "kind": "dns#responsePolicyRule", |
| 336 | "localData": { # 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. |
| 337 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 338 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 339 | "kind": "dns#resourceRecordSet", |
| 340 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 341 | "routingPolicy": { # 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. |
| 342 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 343 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 344 | { |
| 345 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 346 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 347 | "rrdatas": [ |
| 348 | "A String", |
| 349 | ], |
| 350 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 351 | "A String", |
| 352 | ], |
| 353 | }, |
| 354 | ], |
| 355 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 356 | }, |
| 357 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 358 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 359 | { |
| 360 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 361 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 362 | "rrdatas": [ |
| 363 | "A String", |
| 364 | ], |
| 365 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 366 | "A String", |
| 367 | ], |
| 368 | }, |
| 369 | ], |
| 370 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 371 | }, |
| 372 | "kind": "dns#rRSetRoutingPolicy", |
| 373 | "wrr": { |
| 374 | "items": [ |
| 375 | { |
| 376 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 377 | "rrdatas": [ |
| 378 | "A String", |
| 379 | ], |
| 380 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 381 | "A String", |
| 382 | ], |
| 383 | "weight": 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. |
| 384 | }, |
| 385 | ], |
| 386 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 387 | }, |
| 388 | "wrrPolicy": { |
| 389 | "items": [ |
| 390 | { |
| 391 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 392 | "rrdatas": [ |
| 393 | "A String", |
| 394 | ], |
| 395 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 396 | "A String", |
| 397 | ], |
| 398 | "weight": 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. |
| 399 | }, |
| 400 | ], |
| 401 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 402 | }, |
| 403 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 404 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 405 | "A String", |
| 406 | ], |
| 407 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 408 | "A String", |
| 409 | ], |
| 410 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 411 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 412 | }, |
| 413 | ], |
| 414 | }, |
| 415 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 416 | }</pre> |
| 417 | </div> |
| 418 | |
| 419 | <div class="method"> |
| 420 | <code class="details" id="list">list(project, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 421 | <pre>Enumerates all Response Policy Rules associated with a project. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 422 | |
| 423 | Args: |
| 424 | project: string, Identifies the project addressed by this request. (required) |
| 425 | responsePolicy: string, User assigned name of the Response Policy to list. (required) |
| 426 | maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. |
| 427 | pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
| 428 | x__xgafv: string, V1 error format. |
| 429 | Allowed values |
| 430 | 1 - v1 error format |
| 431 | 2 - v2 error format |
| 432 | |
| 433 | Returns: |
| 434 | An object of the form: |
| 435 | |
| 436 | { |
| 437 | "header": { # Elements common to every response. |
| 438 | "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). |
| 439 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 440 | "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 441 | "responsePolicyRules": [ # The Response Policy Rule resources. |
| 442 | { # 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. |
| 443 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 444 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 445 | "kind": "dns#responsePolicyRule", |
| 446 | "localData": { # 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. |
| 447 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 448 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 449 | "kind": "dns#resourceRecordSet", |
| 450 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 451 | "routingPolicy": { # 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. |
| 452 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 453 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 454 | { |
| 455 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 456 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 457 | "rrdatas": [ |
| 458 | "A String", |
| 459 | ], |
| 460 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 461 | "A String", |
| 462 | ], |
| 463 | }, |
| 464 | ], |
| 465 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 466 | }, |
| 467 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 468 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 469 | { |
| 470 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 471 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 472 | "rrdatas": [ |
| 473 | "A String", |
| 474 | ], |
| 475 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 476 | "A String", |
| 477 | ], |
| 478 | }, |
| 479 | ], |
| 480 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 481 | }, |
| 482 | "kind": "dns#rRSetRoutingPolicy", |
| 483 | "wrr": { |
| 484 | "items": [ |
| 485 | { |
| 486 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 487 | "rrdatas": [ |
| 488 | "A String", |
| 489 | ], |
| 490 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 491 | "A String", |
| 492 | ], |
| 493 | "weight": 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. |
| 494 | }, |
| 495 | ], |
| 496 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 497 | }, |
| 498 | "wrrPolicy": { |
| 499 | "items": [ |
| 500 | { |
| 501 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 502 | "rrdatas": [ |
| 503 | "A String", |
| 504 | ], |
| 505 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 506 | "A String", |
| 507 | ], |
| 508 | "weight": 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. |
| 509 | }, |
| 510 | ], |
| 511 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 512 | }, |
| 513 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 514 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 515 | "A String", |
| 516 | ], |
| 517 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 518 | "A String", |
| 519 | ], |
| 520 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 521 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 522 | }, |
| 523 | ], |
| 524 | }, |
| 525 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 526 | }, |
| 527 | ], |
| 528 | }</pre> |
| 529 | </div> |
| 530 | |
| 531 | <div class="method"> |
| 532 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 533 | <pre>Retrieves the next page of results. |
| 534 | |
| 535 | Args: |
| 536 | previous_request: The request for the previous page. (required) |
| 537 | previous_response: The response from the request for the previous page. (required) |
| 538 | |
| 539 | Returns: |
| 540 | A request object that you can call 'execute()' on to request the next |
| 541 | page. Returns None if there are no more items in the collection. |
| 542 | </pre> |
| 543 | </div> |
| 544 | |
| 545 | <div class="method"> |
| 546 | <code class="details" id="patch">patch(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 547 | <pre>Applies a partial update to an existing Response Policy Rule. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 548 | |
| 549 | Args: |
| 550 | project: string, Identifies the project addressed by this request. (required) |
| 551 | responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) |
| 552 | responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) |
| 553 | body: object, The request body. |
| 554 | The object takes the form of: |
| 555 | |
| 556 | { # 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. |
| 557 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 558 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 559 | "kind": "dns#responsePolicyRule", |
| 560 | "localData": { # 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. |
| 561 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 562 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 563 | "kind": "dns#resourceRecordSet", |
| 564 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 565 | "routingPolicy": { # 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. |
| 566 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 567 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 568 | { |
| 569 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 570 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 571 | "rrdatas": [ |
| 572 | "A String", |
| 573 | ], |
| 574 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 575 | "A String", |
| 576 | ], |
| 577 | }, |
| 578 | ], |
| 579 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 580 | }, |
| 581 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 582 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 583 | { |
| 584 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 585 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 586 | "rrdatas": [ |
| 587 | "A String", |
| 588 | ], |
| 589 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 590 | "A String", |
| 591 | ], |
| 592 | }, |
| 593 | ], |
| 594 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 595 | }, |
| 596 | "kind": "dns#rRSetRoutingPolicy", |
| 597 | "wrr": { |
| 598 | "items": [ |
| 599 | { |
| 600 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 601 | "rrdatas": [ |
| 602 | "A String", |
| 603 | ], |
| 604 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 605 | "A String", |
| 606 | ], |
| 607 | "weight": 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. |
| 608 | }, |
| 609 | ], |
| 610 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 611 | }, |
| 612 | "wrrPolicy": { |
| 613 | "items": [ |
| 614 | { |
| 615 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 616 | "rrdatas": [ |
| 617 | "A String", |
| 618 | ], |
| 619 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 620 | "A String", |
| 621 | ], |
| 622 | "weight": 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. |
| 623 | }, |
| 624 | ], |
| 625 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 626 | }, |
| 627 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 628 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 629 | "A String", |
| 630 | ], |
| 631 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 632 | "A String", |
| 633 | ], |
| 634 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 635 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 636 | }, |
| 637 | ], |
| 638 | }, |
| 639 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 640 | } |
| 641 | |
| 642 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 643 | x__xgafv: string, V1 error format. |
| 644 | Allowed values |
| 645 | 1 - v1 error format |
| 646 | 2 - v2 error format |
| 647 | |
| 648 | Returns: |
| 649 | An object of the form: |
| 650 | |
| 651 | { |
| 652 | "header": { # Elements common to every response. |
| 653 | "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). |
| 654 | }, |
| 655 | "responsePolicyRule": { # 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. |
| 656 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 657 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 658 | "kind": "dns#responsePolicyRule", |
| 659 | "localData": { # 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. |
| 660 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 661 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 662 | "kind": "dns#resourceRecordSet", |
| 663 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 664 | "routingPolicy": { # 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. |
| 665 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 666 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 667 | { |
| 668 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 669 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 670 | "rrdatas": [ |
| 671 | "A String", |
| 672 | ], |
| 673 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 674 | "A String", |
| 675 | ], |
| 676 | }, |
| 677 | ], |
| 678 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 679 | }, |
| 680 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 681 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 682 | { |
| 683 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 684 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 685 | "rrdatas": [ |
| 686 | "A String", |
| 687 | ], |
| 688 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 689 | "A String", |
| 690 | ], |
| 691 | }, |
| 692 | ], |
| 693 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 694 | }, |
| 695 | "kind": "dns#rRSetRoutingPolicy", |
| 696 | "wrr": { |
| 697 | "items": [ |
| 698 | { |
| 699 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 700 | "rrdatas": [ |
| 701 | "A String", |
| 702 | ], |
| 703 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 704 | "A String", |
| 705 | ], |
| 706 | "weight": 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. |
| 707 | }, |
| 708 | ], |
| 709 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 710 | }, |
| 711 | "wrrPolicy": { |
| 712 | "items": [ |
| 713 | { |
| 714 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 715 | "rrdatas": [ |
| 716 | "A String", |
| 717 | ], |
| 718 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 719 | "A String", |
| 720 | ], |
| 721 | "weight": 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. |
| 722 | }, |
| 723 | ], |
| 724 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 725 | }, |
| 726 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 727 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 728 | "A String", |
| 729 | ], |
| 730 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 731 | "A String", |
| 732 | ], |
| 733 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 734 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 735 | }, |
| 736 | ], |
| 737 | }, |
| 738 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 739 | }, |
| 740 | }</pre> |
| 741 | </div> |
| 742 | |
| 743 | <div class="method"> |
| 744 | <code class="details" id="update">update(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 745 | <pre>Updates an existing Response Policy Rule. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 746 | |
| 747 | Args: |
| 748 | project: string, Identifies the project addressed by this request. (required) |
| 749 | responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) |
| 750 | responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) |
| 751 | body: object, The request body. |
| 752 | The object takes the form of: |
| 753 | |
| 754 | { # 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. |
| 755 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 756 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 757 | "kind": "dns#responsePolicyRule", |
| 758 | "localData": { # 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. |
| 759 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 760 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 761 | "kind": "dns#resourceRecordSet", |
| 762 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 763 | "routingPolicy": { # 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. |
| 764 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 765 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 766 | { |
| 767 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 768 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 769 | "rrdatas": [ |
| 770 | "A String", |
| 771 | ], |
| 772 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 773 | "A String", |
| 774 | ], |
| 775 | }, |
| 776 | ], |
| 777 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 778 | }, |
| 779 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 780 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 781 | { |
| 782 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 783 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 784 | "rrdatas": [ |
| 785 | "A String", |
| 786 | ], |
| 787 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 788 | "A String", |
| 789 | ], |
| 790 | }, |
| 791 | ], |
| 792 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 793 | }, |
| 794 | "kind": "dns#rRSetRoutingPolicy", |
| 795 | "wrr": { |
| 796 | "items": [ |
| 797 | { |
| 798 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 799 | "rrdatas": [ |
| 800 | "A String", |
| 801 | ], |
| 802 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 803 | "A String", |
| 804 | ], |
| 805 | "weight": 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. |
| 806 | }, |
| 807 | ], |
| 808 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 809 | }, |
| 810 | "wrrPolicy": { |
| 811 | "items": [ |
| 812 | { |
| 813 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 814 | "rrdatas": [ |
| 815 | "A String", |
| 816 | ], |
| 817 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 818 | "A String", |
| 819 | ], |
| 820 | "weight": 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. |
| 821 | }, |
| 822 | ], |
| 823 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 824 | }, |
| 825 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 826 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 827 | "A String", |
| 828 | ], |
| 829 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 830 | "A String", |
| 831 | ], |
| 832 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 833 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 834 | }, |
| 835 | ], |
| 836 | }, |
| 837 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 838 | } |
| 839 | |
| 840 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 841 | x__xgafv: string, V1 error format. |
| 842 | Allowed values |
| 843 | 1 - v1 error format |
| 844 | 2 - v2 error format |
| 845 | |
| 846 | Returns: |
| 847 | An object of the form: |
| 848 | |
| 849 | { |
| 850 | "header": { # Elements common to every response. |
| 851 | "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). |
| 852 | }, |
| 853 | "responsePolicyRule": { # 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. |
| 854 | "behavior": "A String", # Answer this query with a behavior rather than DNS data. |
| 855 | "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. |
| 856 | "kind": "dns#responsePolicyRule", |
| 857 | "localData": { # 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. |
| 858 | "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 859 | { # A unit of data that is returned by the DNS servers. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 860 | "kind": "dns#resourceRecordSet", |
| 861 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 862 | "routingPolicy": { # 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. |
| 863 | "geo": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 864 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 865 | { |
| 866 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 867 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 868 | "rrdatas": [ |
| 869 | "A String", |
| 870 | ], |
| 871 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 872 | "A String", |
| 873 | ], |
| 874 | }, |
| 875 | ], |
| 876 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 877 | }, |
| 878 | "geoPolicy": { |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 879 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 880 | { |
| 881 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 882 | "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc. |
| 883 | "rrdatas": [ |
| 884 | "A String", |
| 885 | ], |
| 886 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 887 | "A String", |
| 888 | ], |
| 889 | }, |
| 890 | ], |
| 891 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 892 | }, |
| 893 | "kind": "dns#rRSetRoutingPolicy", |
| 894 | "wrr": { |
| 895 | "items": [ |
| 896 | { |
| 897 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 898 | "rrdatas": [ |
| 899 | "A String", |
| 900 | ], |
| 901 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 902 | "A String", |
| 903 | ], |
| 904 | "weight": 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. |
| 905 | }, |
| 906 | ], |
| 907 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 908 | }, |
| 909 | "wrrPolicy": { |
| 910 | "items": [ |
| 911 | { |
| 912 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 913 | "rrdatas": [ |
| 914 | "A String", |
| 915 | ], |
| 916 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 917 | "A String", |
| 918 | ], |
| 919 | "weight": 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. |
| 920 | }, |
| 921 | ], |
| 922 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 923 | }, |
| 924 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 925 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 926 | "A String", |
| 927 | ], |
| 928 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 929 | "A String", |
| 930 | ], |
| 931 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 932 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 933 | }, |
| 934 | ], |
| 935 | }, |
| 936 | "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. |
| 937 | }, |
| 938 | }</pre> |
| 939 | </div> |
| 940 | |
| 941 | </body></html> |