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.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> 85<p class="firstline">Deletes a previously created Response Policy Rule.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Fetches the representation of an existing Response Policy Rule.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Enumerates all Response Policy Rules associated with a project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Applies a partial update to an existing Response Policy Rule.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates an existing Response Policy Rule.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="create">create(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code> 109 <pre>Creates a new Response Policy Rule. 110 111Args: 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. 123 { # A unit of data that is returned by the DNS servers. 124 "kind": "dns#resourceRecordSet", 125 "name": "A String", # For example, www.example.com. 126 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 127 "A String", 128 ], 129 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 130 "A String", 131 ], 132 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 133 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 134 }, 135 ], 136 }, 137 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 138} 139 140 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # 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. 150 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 151 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 152 "kind": "dns#responsePolicyRule", 153 "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. 154 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 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 }, 169 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="delete">delete(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</code> 175 <pre>Deletes a previously created Response Policy Rule. 176 177Args: 178 project: string, Identifies the project addressed by this request. (required) 179 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) 180 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) 181 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 182 x__xgafv: string, V1 error format. 183 Allowed values 184 1 - v1 error format 185 2 - v2 error format 186</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="get">get(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)</code> 191 <pre>Fetches the representation of an existing Response Policy Rule. 192 193Args: 194 project: string, Identifies the project addressed by this request. (required) 195 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) 196 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) 197 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 198 x__xgafv: string, V1 error format. 199 Allowed values 200 1 - v1 error format 201 2 - v2 error format 202 203Returns: 204 An object of the form: 205 206 { # 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. 207 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 208 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 209 "kind": "dns#responsePolicyRule", 210 "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. 211 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 212 { # A unit of data that is returned by the DNS servers. 213 "kind": "dns#resourceRecordSet", 214 "name": "A String", # For example, www.example.com. 215 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 216 "A String", 217 ], 218 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 219 "A String", 220 ], 221 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 222 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 223 }, 224 ], 225 }, 226 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 227}</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="list">list(project, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)</code> 232 <pre>Enumerates all Response Policy Rules associated with a project. 233 234Args: 235 project: string, Identifies the project addressed by this request. (required) 236 responsePolicy: string, User assigned name of the Response Policy to list. (required) 237 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. 238 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. 239 x__xgafv: string, V1 error format. 240 Allowed values 241 1 - v1 error format 242 2 - v2 error format 243 244Returns: 245 An object of the form: 246 247 { 248 "header": { # Elements common to every response. 249 "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). 250 }, 251 "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. 252 "responsePolicyRules": [ # The Response Policy Rule resources. 253 { # 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. 254 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 255 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 256 "kind": "dns#responsePolicyRule", 257 "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. 258 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 259 { # A unit of data that is returned by the DNS servers. 260 "kind": "dns#resourceRecordSet", 261 "name": "A String", # For example, www.example.com. 262 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 263 "A String", 264 ], 265 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 266 "A String", 267 ], 268 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 269 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 270 }, 271 ], 272 }, 273 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 274 }, 275 ], 276}</pre> 277</div> 278 279<div class="method"> 280 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 281 <pre>Retrieves the next page of results. 282 283Args: 284 previous_request: The request for the previous page. (required) 285 previous_response: The response from the request for the previous page. (required) 286 287Returns: 288 A request object that you can call 'execute()' on to request the next 289 page. Returns None if there are no more items in the collection. 290 </pre> 291</div> 292 293<div class="method"> 294 <code class="details" id="patch">patch(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</code> 295 <pre>Applies a partial update to an existing Response Policy Rule. 296 297Args: 298 project: string, Identifies the project addressed by this request. (required) 299 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) 300 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) 301 body: object, The request body. 302 The object takes the form of: 303 304{ # 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. 305 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 306 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 307 "kind": "dns#responsePolicyRule", 308 "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. 309 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 310 { # A unit of data that is returned by the DNS servers. 311 "kind": "dns#resourceRecordSet", 312 "name": "A String", # For example, www.example.com. 313 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 314 "A String", 315 ], 316 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 317 "A String", 318 ], 319 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 320 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 321 }, 322 ], 323 }, 324 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 325} 326 327 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 328 x__xgafv: string, V1 error format. 329 Allowed values 330 1 - v1 error format 331 2 - v2 error format 332 333Returns: 334 An object of the form: 335 336 { 337 "header": { # Elements common to every response. 338 "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). 339 }, 340 "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. 341 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 342 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 343 "kind": "dns#responsePolicyRule", 344 "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. 345 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 346 { # A unit of data that is returned by the DNS servers. 347 "kind": "dns#resourceRecordSet", 348 "name": "A String", # For example, www.example.com. 349 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 350 "A String", 351 ], 352 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 353 "A String", 354 ], 355 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 356 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 357 }, 358 ], 359 }, 360 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 361 }, 362}</pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="update">update(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)</code> 367 <pre>Updates an existing Response Policy Rule. 368 369Args: 370 project: string, Identifies the project addressed by this request. (required) 371 responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required) 372 responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required) 373 body: object, The request body. 374 The object takes the form of: 375 376{ # 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. 377 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 378 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 379 "kind": "dns#responsePolicyRule", 380 "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. 381 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 382 { # A unit of data that is returned by the DNS servers. 383 "kind": "dns#resourceRecordSet", 384 "name": "A String", # For example, www.example.com. 385 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 386 "A String", 387 ], 388 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 389 "A String", 390 ], 391 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 392 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 393 }, 394 ], 395 }, 396 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 397} 398 399 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 400 x__xgafv: string, V1 error format. 401 Allowed values 402 1 - v1 error format 403 2 - v2 error format 404 405Returns: 406 An object of the form: 407 408 { 409 "header": { # Elements common to every response. 410 "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). 411 }, 412 "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. 413 "behavior": "A String", # Answer this query with a behavior rather than DNS data. 414 "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. 415 "kind": "dns#responsePolicyRule", 416 "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. 417 "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name. 418 { # A unit of data that is returned by the DNS servers. 419 "kind": "dns#resourceRecordSet", 420 "name": "A String", # For example, www.example.com. 421 "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. 422 "A String", 423 ], 424 "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). 425 "A String", 426 ], 427 "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. 428 "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. 429 }, 430 ], 431 }, 432 "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy. 433 }, 434}</pre> 435</div> 436 437</body></html>