1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.changes.html">changes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#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, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Atomically updates the ResourceRecordSet collection.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Fetches the representation of an existing Change.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(project, managedZone, maxResults=None, pageToken=None, sortBy=None, sortOrder=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Enumerates Changes to a ResourceRecordSet collection.</p> 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"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> 100 <pre>Atomically updates the ResourceRecordSet collection. 101 102Args: 103 project: string, Identifies the project addressed by this request. (required) 104 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) 105 body: object, The request body. 106 The object takes the form of: 107 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. 109 "additions": [ # Which ResourceRecordSets to add? 110 { # A unit of data that is returned by the DNS servers. 111 "kind": "dns#resourceRecordSet", 112 "name": "A String", # For example, www.example.com. 113 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 114 "A String", 115 ], 116 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 117 "A String", 118 ], 119 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 120 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 121 }, 122 ], 123 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. 124 { # A unit of data that is returned by the DNS servers. 125 "kind": "dns#resourceRecordSet", 126 "name": "A String", # For example, www.example.com. 127 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 128 "A String", 129 ], 130 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 131 "A String", 132 ], 133 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 134 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 135 }, 136 ], 137 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 138 "isServing": True or False, # If the DNS queries for the zone will be served. 139 "kind": "dns#change", 140 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. 141 "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. 142} 143 144 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 145 x__xgafv: string, V1 error format. 146 Allowed values 147 1 - v1 error format 148 2 - v2 error format 149 150Returns: 151 An object of the form: 152 153 { # 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. 154 "additions": [ # Which ResourceRecordSets to add? 155 { # A unit of data that is returned by the DNS servers. 156 "kind": "dns#resourceRecordSet", 157 "name": "A String", # For example, www.example.com. 158 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 159 "A String", 160 ], 161 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 162 "A String", 163 ], 164 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 165 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 166 }, 167 ], 168 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. 169 { # A unit of data that is returned by the DNS servers. 170 "kind": "dns#resourceRecordSet", 171 "name": "A String", # For example, www.example.com. 172 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 173 "A String", 174 ], 175 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 176 "A String", 177 ], 178 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 179 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 180 }, 181 ], 182 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 183 "isServing": True or False, # If the DNS queries for the zone will be served. 184 "kind": "dns#change", 185 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. 186 "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. 187}</pre> 188</div> 189 190<div class="method"> 191 <code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)</code> 192 <pre>Fetches the representation of an existing Change. 193 194Args: 195 project: string, Identifies the project addressed by this request. (required) 196 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) 197 changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required) 198 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # 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. 208 "additions": [ # Which ResourceRecordSets to add? 209 { # A unit of data that is returned by the DNS servers. 210 "kind": "dns#resourceRecordSet", 211 "name": "A String", # For example, www.example.com. 212 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 213 "A String", 214 ], 215 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 216 "A String", 217 ], 218 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 219 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 220 }, 221 ], 222 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. 223 { # A unit of data that is returned by the DNS servers. 224 "kind": "dns#resourceRecordSet", 225 "name": "A String", # For example, www.example.com. 226 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 227 "A String", 228 ], 229 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 230 "A String", 231 ], 232 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 233 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 234 }, 235 ], 236 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 237 "isServing": True or False, # If the DNS queries for the zone will be served. 238 "kind": "dns#change", 239 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. 240 "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. 241}</pre> 242</div> 243 244<div class="method"> 245 <code class="details" id="list">list(project, managedZone, maxResults=None, pageToken=None, sortBy=None, sortOrder=None, x__xgafv=None)</code> 246 <pre>Enumerates Changes to a ResourceRecordSet collection. 247 248Args: 249 project: string, Identifies the project addressed by this request. (required) 250 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) 251 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. 252 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. 253 sortBy: string, Sorting criterion. The only supported value is change sequence. 254 Allowed values 255 changeSequence - 256 sortOrder: string, Sorting order direction: 'ascending' or 'descending'. 257 x__xgafv: string, V1 error format. 258 Allowed values 259 1 - v1 error format 260 2 - v2 error format 261 262Returns: 263 An object of the form: 264 265 { # The response to a request to enumerate Changes to a ResourceRecordSets collection. 266 "changes": [ # The requested changes. 267 { # 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. 268 "additions": [ # Which ResourceRecordSets to add? 269 { # A unit of data that is returned by the DNS servers. 270 "kind": "dns#resourceRecordSet", 271 "name": "A String", # For example, www.example.com. 272 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 273 "A String", 274 ], 275 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 276 "A String", 277 ], 278 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 279 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 280 }, 281 ], 282 "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly. 283 { # A unit of data that is returned by the DNS servers. 284 "kind": "dns#resourceRecordSet", 285 "name": "A String", # For example, www.example.com. 286 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 287 "A String", 288 ], 289 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 290 "A String", 291 ], 292 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 293 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 294 }, 295 ], 296 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 297 "isServing": True or False, # If the DNS queries for the zone will be served. 298 "kind": "dns#change", 299 "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. 300 "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. 301 }, 302 ], 303 "header": { # Elements common to every response. 304 "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). 305 }, 306 "kind": "dns#changesListResponse", # Type of resource. 307 "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. 308}</pre> 309</div> 310 311<div class="method"> 312 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 313 <pre>Retrieves the next page of results. 314 315Args: 316 previous_request: The request for the previous page. (required) 317 previous_response: The response from the request for the previous page. (required) 318 319Returns: 320 A request object that you can call 'execute()' on to request the next 321 page. Returns None if there are no more items in the collection. 322 </pre> 323</div> 324 325</body></html>