| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [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 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.changes.html">changes</a></h1> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 82 | <p class="firstline">Atomically updates the ResourceRecordSet collection.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 84 | <code><a href="#get">get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 85 | <p class="firstline">Fetches the representation of an existing Change.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 87 | <code><a href="#list">list(project, managedZone, maxResults=None, pageToken=None, sortBy=None, sortOrder=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 88 | <p class="firstline">Enumerates Changes to a ResourceRecordSet collection.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <code class="details" id="create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 100 | <pre>Atomically updates the ResourceRecordSet collection. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 101 | |
| 102 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 103 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 104 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | The object takes the form of: |
| 107 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 108 | { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 109 | "additions": [ # Which ResourceRecordSets to add? |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 110 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 111 | "kind": "dns#resourceRecordSet", |
| 112 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 113 | "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. |
| 114 | "geo": { |
| 115 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 116 | { |
| 117 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 118 | "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. |
| 119 | "rrdatas": [ |
| 120 | "A String", |
| 121 | ], |
| 122 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 123 | "A String", |
| 124 | ], |
| 125 | }, |
| 126 | ], |
| 127 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 128 | { |
| 129 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 130 | "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. |
| 131 | "rrdatas": [ |
| 132 | "A String", |
| 133 | ], |
| 134 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 135 | "A String", |
| 136 | ], |
| 137 | }, |
| 138 | ], |
| 139 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 140 | }, |
| 141 | "geoPolicy": { |
| 142 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 143 | { |
| 144 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 145 | "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. |
| 146 | "rrdatas": [ |
| 147 | "A String", |
| 148 | ], |
| 149 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 150 | "A String", |
| 151 | ], |
| 152 | }, |
| 153 | ], |
| 154 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 155 | { |
| 156 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 157 | "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. |
| 158 | "rrdatas": [ |
| 159 | "A String", |
| 160 | ], |
| 161 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 162 | "A String", |
| 163 | ], |
| 164 | }, |
| 165 | ], |
| 166 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 167 | }, |
| 168 | "kind": "dns#rRSetRoutingPolicy", |
| 169 | "wrr": { |
| 170 | "items": [ |
| 171 | { |
| 172 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 173 | "rrdatas": [ |
| 174 | "A String", |
| 175 | ], |
| 176 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 177 | "A String", |
| 178 | ], |
| 179 | "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. |
| 180 | }, |
| 181 | ], |
| 182 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 183 | }, |
| 184 | "wrrPolicy": { |
| 185 | "items": [ |
| 186 | { |
| 187 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 188 | "rrdatas": [ |
| 189 | "A String", |
| 190 | ], |
| 191 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 192 | "A String", |
| 193 | ], |
| 194 | "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. |
| 195 | }, |
| 196 | ], |
| 197 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 198 | }, |
| 199 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 200 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 201 | "A String", |
| 202 | ], |
| 203 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 204 | "A String", |
| 205 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 206 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 207 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 208 | }, |
| 209 | ], |
| 210 | "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 211 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 212 | "kind": "dns#resourceRecordSet", |
| 213 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 214 | "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. |
| 215 | "geo": { |
| 216 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 217 | { |
| 218 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 219 | "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. |
| 220 | "rrdatas": [ |
| 221 | "A String", |
| 222 | ], |
| 223 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 224 | "A String", |
| 225 | ], |
| 226 | }, |
| 227 | ], |
| 228 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 229 | { |
| 230 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 231 | "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. |
| 232 | "rrdatas": [ |
| 233 | "A String", |
| 234 | ], |
| 235 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 236 | "A String", |
| 237 | ], |
| 238 | }, |
| 239 | ], |
| 240 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 241 | }, |
| 242 | "geoPolicy": { |
| 243 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 244 | { |
| 245 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 246 | "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. |
| 247 | "rrdatas": [ |
| 248 | "A String", |
| 249 | ], |
| 250 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 251 | "A String", |
| 252 | ], |
| 253 | }, |
| 254 | ], |
| 255 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 256 | { |
| 257 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 258 | "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. |
| 259 | "rrdatas": [ |
| 260 | "A String", |
| 261 | ], |
| 262 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 263 | "A String", |
| 264 | ], |
| 265 | }, |
| 266 | ], |
| 267 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 268 | }, |
| 269 | "kind": "dns#rRSetRoutingPolicy", |
| 270 | "wrr": { |
| 271 | "items": [ |
| 272 | { |
| 273 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 274 | "rrdatas": [ |
| 275 | "A String", |
| 276 | ], |
| 277 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 278 | "A String", |
| 279 | ], |
| 280 | "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. |
| 281 | }, |
| 282 | ], |
| 283 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 284 | }, |
| 285 | "wrrPolicy": { |
| 286 | "items": [ |
| 287 | { |
| 288 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 289 | "rrdatas": [ |
| 290 | "A String", |
| 291 | ], |
| 292 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 293 | "A String", |
| 294 | ], |
| 295 | "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. |
| 296 | }, |
| 297 | ], |
| 298 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 299 | }, |
| 300 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 301 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 302 | "A String", |
| 303 | ], |
| 304 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 305 | "A String", |
| 306 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 307 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 308 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 309 | }, |
| 310 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 311 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 312 | "isServing": True or False, # If the DNS queries for the zone will be served. |
| 313 | "kind": "dns#change", |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 314 | "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 315 | "status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 316 | } |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 317 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 318 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 319 | x__xgafv: string, V1 error format. |
| 320 | Allowed values |
| 321 | 1 - v1 error format |
| 322 | 2 - v2 error format |
| 323 | |
| 324 | Returns: |
| 325 | An object of the form: |
| 326 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 327 | { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 328 | "additions": [ # Which ResourceRecordSets to add? |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 329 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 330 | "kind": "dns#resourceRecordSet", |
| 331 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 332 | "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. |
| 333 | "geo": { |
| 334 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 335 | { |
| 336 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 337 | "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. |
| 338 | "rrdatas": [ |
| 339 | "A String", |
| 340 | ], |
| 341 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 342 | "A String", |
| 343 | ], |
| 344 | }, |
| 345 | ], |
| 346 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 347 | { |
| 348 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 349 | "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. |
| 350 | "rrdatas": [ |
| 351 | "A String", |
| 352 | ], |
| 353 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 354 | "A String", |
| 355 | ], |
| 356 | }, |
| 357 | ], |
| 358 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 359 | }, |
| 360 | "geoPolicy": { |
| 361 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 362 | { |
| 363 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 364 | "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. |
| 365 | "rrdatas": [ |
| 366 | "A String", |
| 367 | ], |
| 368 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 369 | "A String", |
| 370 | ], |
| 371 | }, |
| 372 | ], |
| 373 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 374 | { |
| 375 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 376 | "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. |
| 377 | "rrdatas": [ |
| 378 | "A String", |
| 379 | ], |
| 380 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 381 | "A String", |
| 382 | ], |
| 383 | }, |
| 384 | ], |
| 385 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 386 | }, |
| 387 | "kind": "dns#rRSetRoutingPolicy", |
| 388 | "wrr": { |
| 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 | "wrrPolicy": { |
| 404 | "items": [ |
| 405 | { |
| 406 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 407 | "rrdatas": [ |
| 408 | "A String", |
| 409 | ], |
| 410 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 411 | "A String", |
| 412 | ], |
| 413 | "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. |
| 414 | }, |
| 415 | ], |
| 416 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 417 | }, |
| 418 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 419 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 420 | "A String", |
| 421 | ], |
| 422 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 423 | "A String", |
| 424 | ], |
| 425 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 426 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 427 | }, |
| 428 | ], |
| 429 | "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 430 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 431 | "kind": "dns#resourceRecordSet", |
| 432 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 433 | "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. |
| 434 | "geo": { |
| 435 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 436 | { |
| 437 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 438 | "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. |
| 439 | "rrdatas": [ |
| 440 | "A String", |
| 441 | ], |
| 442 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 443 | "A String", |
| 444 | ], |
| 445 | }, |
| 446 | ], |
| 447 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 448 | { |
| 449 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 450 | "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. |
| 451 | "rrdatas": [ |
| 452 | "A String", |
| 453 | ], |
| 454 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 455 | "A String", |
| 456 | ], |
| 457 | }, |
| 458 | ], |
| 459 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 460 | }, |
| 461 | "geoPolicy": { |
| 462 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 463 | { |
| 464 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 465 | "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. |
| 466 | "rrdatas": [ |
| 467 | "A String", |
| 468 | ], |
| 469 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 470 | "A String", |
| 471 | ], |
| 472 | }, |
| 473 | ], |
| 474 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 475 | { |
| 476 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 477 | "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. |
| 478 | "rrdatas": [ |
| 479 | "A String", |
| 480 | ], |
| 481 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 482 | "A String", |
| 483 | ], |
| 484 | }, |
| 485 | ], |
| 486 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 487 | }, |
| 488 | "kind": "dns#rRSetRoutingPolicy", |
| 489 | "wrr": { |
| 490 | "items": [ |
| 491 | { |
| 492 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 493 | "rrdatas": [ |
| 494 | "A String", |
| 495 | ], |
| 496 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 497 | "A String", |
| 498 | ], |
| 499 | "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. |
| 500 | }, |
| 501 | ], |
| 502 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 503 | }, |
| 504 | "wrrPolicy": { |
| 505 | "items": [ |
| 506 | { |
| 507 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 508 | "rrdatas": [ |
| 509 | "A String", |
| 510 | ], |
| 511 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 512 | "A String", |
| 513 | ], |
| 514 | "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. |
| 515 | }, |
| 516 | ], |
| 517 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 518 | }, |
| 519 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 520 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 521 | "A String", |
| 522 | ], |
| 523 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 524 | "A String", |
| 525 | ], |
| 526 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 527 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 528 | }, |
| 529 | ], |
| 530 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 531 | "isServing": True or False, # If the DNS queries for the zone will be served. |
| 532 | "kind": "dns#change", |
| 533 | "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 534 | "status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 535 | }</pre> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 536 | </div> |
| 537 | |
| 538 | <div class="method"> |
| 539 | <code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 540 | <pre>Fetches the representation of an existing Change. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 541 | |
| 542 | Args: |
| 543 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 544 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 545 | changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required) |
| 546 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 547 | x__xgafv: string, V1 error format. |
| 548 | Allowed values |
| 549 | 1 - v1 error format |
| 550 | 2 - v2 error format |
| 551 | |
| 552 | Returns: |
| 553 | An object of the form: |
| 554 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 555 | { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 556 | "additions": [ # Which ResourceRecordSets to add? |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 557 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 558 | "kind": "dns#resourceRecordSet", |
| 559 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 560 | "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. |
| 561 | "geo": { |
| 562 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 563 | { |
| 564 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 565 | "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. |
| 566 | "rrdatas": [ |
| 567 | "A String", |
| 568 | ], |
| 569 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 570 | "A String", |
| 571 | ], |
| 572 | }, |
| 573 | ], |
| 574 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 575 | { |
| 576 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 577 | "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. |
| 578 | "rrdatas": [ |
| 579 | "A String", |
| 580 | ], |
| 581 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 582 | "A String", |
| 583 | ], |
| 584 | }, |
| 585 | ], |
| 586 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 587 | }, |
| 588 | "geoPolicy": { |
| 589 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 590 | { |
| 591 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 592 | "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. |
| 593 | "rrdatas": [ |
| 594 | "A String", |
| 595 | ], |
| 596 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 597 | "A String", |
| 598 | ], |
| 599 | }, |
| 600 | ], |
| 601 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 602 | { |
| 603 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 604 | "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. |
| 605 | "rrdatas": [ |
| 606 | "A String", |
| 607 | ], |
| 608 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 609 | "A String", |
| 610 | ], |
| 611 | }, |
| 612 | ], |
| 613 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 614 | }, |
| 615 | "kind": "dns#rRSetRoutingPolicy", |
| 616 | "wrr": { |
| 617 | "items": [ |
| 618 | { |
| 619 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 620 | "rrdatas": [ |
| 621 | "A String", |
| 622 | ], |
| 623 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 624 | "A String", |
| 625 | ], |
| 626 | "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. |
| 627 | }, |
| 628 | ], |
| 629 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 630 | }, |
| 631 | "wrrPolicy": { |
| 632 | "items": [ |
| 633 | { |
| 634 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 635 | "rrdatas": [ |
| 636 | "A String", |
| 637 | ], |
| 638 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 639 | "A String", |
| 640 | ], |
| 641 | "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. |
| 642 | }, |
| 643 | ], |
| 644 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 645 | }, |
| 646 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 647 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 648 | "A String", |
| 649 | ], |
| 650 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 651 | "A String", |
| 652 | ], |
| 653 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 654 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 655 | }, |
| 656 | ], |
| 657 | "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 658 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 659 | "kind": "dns#resourceRecordSet", |
| 660 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 661 | "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. |
| 662 | "geo": { |
| 663 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 664 | { |
| 665 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 666 | "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. |
| 667 | "rrdatas": [ |
| 668 | "A String", |
| 669 | ], |
| 670 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 671 | "A String", |
| 672 | ], |
| 673 | }, |
| 674 | ], |
| 675 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 676 | { |
| 677 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 678 | "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. |
| 679 | "rrdatas": [ |
| 680 | "A String", |
| 681 | ], |
| 682 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 683 | "A String", |
| 684 | ], |
| 685 | }, |
| 686 | ], |
| 687 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 688 | }, |
| 689 | "geoPolicy": { |
| 690 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 691 | { |
| 692 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 693 | "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. |
| 694 | "rrdatas": [ |
| 695 | "A String", |
| 696 | ], |
| 697 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 698 | "A String", |
| 699 | ], |
| 700 | }, |
| 701 | ], |
| 702 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 703 | { |
| 704 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 705 | "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. |
| 706 | "rrdatas": [ |
| 707 | "A String", |
| 708 | ], |
| 709 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 710 | "A String", |
| 711 | ], |
| 712 | }, |
| 713 | ], |
| 714 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 715 | }, |
| 716 | "kind": "dns#rRSetRoutingPolicy", |
| 717 | "wrr": { |
| 718 | "items": [ |
| 719 | { |
| 720 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 721 | "rrdatas": [ |
| 722 | "A String", |
| 723 | ], |
| 724 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 725 | "A String", |
| 726 | ], |
| 727 | "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. |
| 728 | }, |
| 729 | ], |
| 730 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 731 | }, |
| 732 | "wrrPolicy": { |
| 733 | "items": [ |
| 734 | { |
| 735 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 736 | "rrdatas": [ |
| 737 | "A String", |
| 738 | ], |
| 739 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 740 | "A String", |
| 741 | ], |
| 742 | "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. |
| 743 | }, |
| 744 | ], |
| 745 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 746 | }, |
| 747 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 748 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 749 | "A String", |
| 750 | ], |
| 751 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 752 | "A String", |
| 753 | ], |
| 754 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 755 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 756 | }, |
| 757 | ], |
| 758 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 759 | "isServing": True or False, # If the DNS queries for the zone will be served. |
| 760 | "kind": "dns#change", |
| 761 | "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 762 | "status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 763 | }</pre> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 764 | </div> |
| 765 | |
| 766 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 767 | <code class="details" id="list">list(project, managedZone, maxResults=None, pageToken=None, sortBy=None, sortOrder=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 768 | <pre>Enumerates Changes to a ResourceRecordSet collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 769 | |
| 770 | Args: |
| 771 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 772 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 773 | maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 774 | pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 775 | sortBy: string, Sorting criterion. The only supported value is change sequence. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 776 | Allowed values |
| 777 | changeSequence - |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 778 | sortOrder: string, Sorting order direction: 'ascending' or 'descending'. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 779 | x__xgafv: string, V1 error format. |
| 780 | Allowed values |
| 781 | 1 - v1 error format |
| 782 | 2 - v2 error format |
| 783 | |
| 784 | Returns: |
| 785 | An object of the form: |
| 786 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 787 | { # The response to a request to enumerate Changes to a ResourceRecordSets collection. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 788 | "changes": [ # The requested changes. |
| 789 | { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. |
| 790 | "additions": [ # Which ResourceRecordSets to add? |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 791 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 792 | "kind": "dns#resourceRecordSet", |
| 793 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 794 | "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. |
| 795 | "geo": { |
| 796 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 797 | { |
| 798 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 799 | "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. |
| 800 | "rrdatas": [ |
| 801 | "A String", |
| 802 | ], |
| 803 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 804 | "A String", |
| 805 | ], |
| 806 | }, |
| 807 | ], |
| 808 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 809 | { |
| 810 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 811 | "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. |
| 812 | "rrdatas": [ |
| 813 | "A String", |
| 814 | ], |
| 815 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 816 | "A String", |
| 817 | ], |
| 818 | }, |
| 819 | ], |
| 820 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 821 | }, |
| 822 | "geoPolicy": { |
| 823 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 824 | { |
| 825 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 826 | "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. |
| 827 | "rrdatas": [ |
| 828 | "A String", |
| 829 | ], |
| 830 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 831 | "A String", |
| 832 | ], |
| 833 | }, |
| 834 | ], |
| 835 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 836 | { |
| 837 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 838 | "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. |
| 839 | "rrdatas": [ |
| 840 | "A String", |
| 841 | ], |
| 842 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 843 | "A String", |
| 844 | ], |
| 845 | }, |
| 846 | ], |
| 847 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 848 | }, |
| 849 | "kind": "dns#rRSetRoutingPolicy", |
| 850 | "wrr": { |
| 851 | "items": [ |
| 852 | { |
| 853 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 854 | "rrdatas": [ |
| 855 | "A String", |
| 856 | ], |
| 857 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 858 | "A String", |
| 859 | ], |
| 860 | "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. |
| 861 | }, |
| 862 | ], |
| 863 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 864 | }, |
| 865 | "wrrPolicy": { |
| 866 | "items": [ |
| 867 | { |
| 868 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 869 | "rrdatas": [ |
| 870 | "A String", |
| 871 | ], |
| 872 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 873 | "A String", |
| 874 | ], |
| 875 | "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. |
| 876 | }, |
| 877 | ], |
| 878 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 879 | }, |
| 880 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 881 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 882 | "A String", |
| 883 | ], |
| 884 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 885 | "A String", |
| 886 | ], |
| 887 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 888 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 889 | }, |
| 890 | ], |
| 891 | "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 892 | { # A unit of data that is returned by the DNS servers. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 893 | "kind": "dns#resourceRecordSet", |
| 894 | "name": "A String", # For example, www.example.com. |
| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame^] | 895 | "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. |
| 896 | "geo": { |
| 897 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 898 | { |
| 899 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 900 | "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. |
| 901 | "rrdatas": [ |
| 902 | "A String", |
| 903 | ], |
| 904 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 905 | "A String", |
| 906 | ], |
| 907 | }, |
| 908 | ], |
| 909 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 910 | { |
| 911 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 912 | "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. |
| 913 | "rrdatas": [ |
| 914 | "A String", |
| 915 | ], |
| 916 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 917 | "A String", |
| 918 | ], |
| 919 | }, |
| 920 | ], |
| 921 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 922 | }, |
| 923 | "geoPolicy": { |
| 924 | "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked, and it returns the primarily configured rrdata irrespective of whether it is healthy or not. |
| 925 | { |
| 926 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 927 | "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. |
| 928 | "rrdatas": [ |
| 929 | "A String", |
| 930 | ], |
| 931 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 932 | "A String", |
| 933 | ], |
| 934 | }, |
| 935 | ], |
| 936 | "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| 937 | { |
| 938 | "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| 939 | "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. |
| 940 | "rrdatas": [ |
| 941 | "A String", |
| 942 | ], |
| 943 | "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| 944 | "A String", |
| 945 | ], |
| 946 | }, |
| 947 | ], |
| 948 | "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| 949 | }, |
| 950 | "kind": "dns#rRSetRoutingPolicy", |
| 951 | "wrr": { |
| 952 | "items": [ |
| 953 | { |
| 954 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 955 | "rrdatas": [ |
| 956 | "A String", |
| 957 | ], |
| 958 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 959 | "A String", |
| 960 | ], |
| 961 | "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. |
| 962 | }, |
| 963 | ], |
| 964 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 965 | }, |
| 966 | "wrrPolicy": { |
| 967 | "items": [ |
| 968 | { |
| 969 | "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| 970 | "rrdatas": [ |
| 971 | "A String", |
| 972 | ], |
| 973 | "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| 974 | "A String", |
| 975 | ], |
| 976 | "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. |
| 977 | }, |
| 978 | ], |
| 979 | "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| 980 | }, |
| 981 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 982 | "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| 983 | "A String", |
| 984 | ], |
| 985 | "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| 986 | "A String", |
| 987 | ], |
| 988 | "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| 989 | "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| 990 | }, |
| 991 | ], |
| 992 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 993 | "isServing": True or False, # If the DNS queries for the zone will be served. |
| 994 | "kind": "dns#change", |
| 995 | "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 996 | "status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 997 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 998 | ], |
| 999 | "header": { # Elements common to every response. |
| 1000 | "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). |
| 1001 | }, |
| 1002 | "kind": "dns#changesListResponse", # Type of resource. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1003 | "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a "snapshot" of collections larger than the maximum page size. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1004 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1005 | </div> |
| 1006 | |
| 1007 | <div class="method"> |
| 1008 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1009 | <pre>Retrieves the next page of results. |
| 1010 | |
| 1011 | Args: |
| 1012 | previous_request: The request for the previous page. (required) |
| 1013 | previous_response: The response from the request for the previous page. (required) |
| 1014 | |
| 1015 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1016 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1017 | page. Returns None if there are no more items in the collection. |
| 1018 | </pre> |
| 1019 | </div> |
| 1020 | |
| 1021 | </body></html> |