| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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_v1.html">Cloud DNS API</a> . <a href="dns_v1.policies.html">policies</a></h1> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 78 | <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Create a new Policy</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Delete a previously created Policy. Will fail if the policy is still being</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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, policy, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Fetch the representation of an existing Policy.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(project, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Enumerate all Policies associated with a project.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 93 | <code><a href="#patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Apply a partial update to an existing Policy.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 96 | <code><a href="#update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Update an existing Policy.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 100 | <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code> |
| 101 | <pre>Create a new Policy |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | |
| 103 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 104 | project: string, Identifies the project addressed by this request. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | body: object, The request body. |
| 106 | The object takes the form of: |
| 107 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 108 | { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 109 | # Cloud resources. |
| 110 | "kind": "dns#policy", |
| 111 | "name": "A String", # User assigned name for this policy. |
| 112 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 113 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 114 | { |
| 115 | "kind": "dns#policyNetwork", |
| 116 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 117 | # This should be formatted like |
| 118 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 119 | }, |
| 120 | ], |
| 121 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 122 | # for the user's convenience. Has no effect on the policy's function. |
| 123 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 124 | # Defaults to no logging if not set. |
| 125 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 126 | # applications over VPN connections. When enabled, a virtual IP address will |
| 127 | # be allocated from each of the sub-networks that are bound to this policy. |
| 128 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 129 | # specified, all DNS queries are forwarded to a name server that you |
| 130 | # choose. Names such as .internal are not available when an alternative |
| 131 | # name server is specified. |
| 132 | "kind": "dns#policyAlternativeNameServerConfig", |
| 133 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 134 | # specified, all DNS queries are forwarded to a name server that you |
| 135 | # choose. Names such as .internal are not available when an alternative |
| 136 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 138 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 139 | # Cloud DNS will make forwarding decision based on address ranges, |
| 140 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 141 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 142 | # through VPC for this target |
| 143 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 144 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | }, |
| 146 | ], |
| 147 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | } |
| 149 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 150 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 151 | specified by the client. Must be unique for operation resources in the |
| 152 | Operations collection. |
| 153 | x__xgafv: string, V1 error format. |
| 154 | Allowed values |
| 155 | 1 - v1 error format |
| 156 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | |
| 158 | Returns: |
| 159 | An object of the form: |
| 160 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 161 | { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 162 | # Cloud resources. |
| 163 | "kind": "dns#policy", |
| 164 | "name": "A String", # User assigned name for this policy. |
| 165 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 166 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 167 | { |
| 168 | "kind": "dns#policyNetwork", |
| 169 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 170 | # This should be formatted like |
| 171 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 172 | }, |
| 173 | ], |
| 174 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 175 | # for the user's convenience. Has no effect on the policy's function. |
| 176 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 177 | # Defaults to no logging if not set. |
| 178 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 179 | # applications over VPN connections. When enabled, a virtual IP address will |
| 180 | # be allocated from each of the sub-networks that are bound to this policy. |
| 181 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 182 | # specified, all DNS queries are forwarded to a name server that you |
| 183 | # choose. Names such as .internal are not available when an alternative |
| 184 | # name server is specified. |
| 185 | "kind": "dns#policyAlternativeNameServerConfig", |
| 186 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 187 | # specified, all DNS queries are forwarded to a name server that you |
| 188 | # choose. Names such as .internal are not available when an alternative |
| 189 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 191 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 192 | # Cloud DNS will make forwarding decision based on address ranges, |
| 193 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 194 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 195 | # through VPC for this target |
| 196 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 197 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 198 | }, |
| 199 | ], |
| 200 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | }</pre> |
| 202 | </div> |
| 203 | |
| 204 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 205 | <code class="details" id="delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</code> |
| 206 | <pre>Delete a previously created Policy. Will fail if the policy is still being |
| 207 | referenced by a network. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | |
| 209 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 210 | project: string, Identifies the project addressed by this request. (required) |
| 211 | policy: string, User given friendly name of the policy addressed by this request. (required) |
| 212 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 213 | specified by the client. Must be unique for operation resources in the |
| 214 | Operations collection. |
| 215 | x__xgafv: string, V1 error format. |
| 216 | Allowed values |
| 217 | 1 - v1 error format |
| 218 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 219 | </pre> |
| 220 | </div> |
| 221 | |
| 222 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 223 | <code class="details" id="get">get(project, policy, clientOperationId=None, x__xgafv=None)</code> |
| 224 | <pre>Fetch the representation of an existing Policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 225 | |
| 226 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 227 | project: string, Identifies the project addressed by this request. (required) |
| 228 | policy: string, User given friendly name of the policy addressed by this request. (required) |
| 229 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 230 | specified by the client. Must be unique for operation resources in the |
| 231 | Operations collection. |
| 232 | x__xgafv: string, V1 error format. |
| 233 | Allowed values |
| 234 | 1 - v1 error format |
| 235 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | |
| 237 | Returns: |
| 238 | An object of the form: |
| 239 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 240 | { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 241 | # Cloud resources. |
| 242 | "kind": "dns#policy", |
| 243 | "name": "A String", # User assigned name for this policy. |
| 244 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 245 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 246 | { |
| 247 | "kind": "dns#policyNetwork", |
| 248 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 249 | # This should be formatted like |
| 250 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 251 | }, |
| 252 | ], |
| 253 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 254 | # for the user's convenience. Has no effect on the policy's function. |
| 255 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 256 | # Defaults to no logging if not set. |
| 257 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 258 | # applications over VPN connections. When enabled, a virtual IP address will |
| 259 | # be allocated from each of the sub-networks that are bound to this policy. |
| 260 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 261 | # specified, all DNS queries are forwarded to a name server that you |
| 262 | # choose. Names such as .internal are not available when an alternative |
| 263 | # name server is specified. |
| 264 | "kind": "dns#policyAlternativeNameServerConfig", |
| 265 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 266 | # specified, all DNS queries are forwarded to a name server that you |
| 267 | # choose. Names such as .internal are not available when an alternative |
| 268 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 269 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 270 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 271 | # Cloud DNS will make forwarding decision based on address ranges, |
| 272 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 273 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 274 | # through VPC for this target |
| 275 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 276 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 277 | }, |
| 278 | ], |
| 279 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 280 | }</pre> |
| 281 | </div> |
| 282 | |
| 283 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 284 | <code class="details" id="list">list(project, pageToken=None, maxResults=None, x__xgafv=None)</code> |
| 285 | <pre>Enumerate all Policies associated with a project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | |
| 287 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 288 | project: string, Identifies the project addressed by this request. (required) |
| 289 | pageToken: string, Optional. A tag returned by a previous list request that was truncated. |
| 290 | Use this parameter to continue a previous list request. |
| 291 | maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the |
| 292 | server will decide how many results to return. |
| 293 | x__xgafv: string, V1 error format. |
| 294 | Allowed values |
| 295 | 1 - v1 error format |
| 296 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 297 | |
| 298 | Returns: |
| 299 | An object of the form: |
| 300 | |
| 301 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 302 | "kind": "dns#policiesListResponse", # Type of resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 303 | "policies": [ # The policy resources. |
| 304 | { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 305 | # Cloud resources. |
| 306 | "kind": "dns#policy", |
| 307 | "name": "A String", # User assigned name for this policy. |
| 308 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 309 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 310 | { |
| 311 | "kind": "dns#policyNetwork", |
| 312 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 313 | # This should be formatted like |
| 314 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 315 | }, |
| 316 | ], |
| 317 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 318 | # for the user's convenience. Has no effect on the policy's function. |
| 319 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 320 | # Defaults to no logging if not set. |
| 321 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 322 | # applications over VPN connections. When enabled, a virtual IP address will |
| 323 | # be allocated from each of the sub-networks that are bound to this policy. |
| 324 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 325 | # specified, all DNS queries are forwarded to a name server that you |
| 326 | # choose. Names such as .internal are not available when an alternative |
| 327 | # name server is specified. |
| 328 | "kind": "dns#policyAlternativeNameServerConfig", |
| 329 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 330 | # specified, all DNS queries are forwarded to a name server that you |
| 331 | # choose. Names such as .internal are not available when an alternative |
| 332 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 333 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 334 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 335 | # Cloud DNS will make forwarding decision based on address ranges, |
| 336 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 337 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 338 | # through VPC for this target |
| 339 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 340 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 341 | }, |
| 342 | ], |
| 343 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 344 | }, |
| 345 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 346 | "nextPageToken": "A String", # The presence of this field indicates that there exist more results |
| 347 | # following your last page of results in pagination order. To fetch them, |
| 348 | # make another list request using this value as your page token. |
| 349 | # |
| 350 | # In this way you can retrieve the complete contents of even very large |
| 351 | # collections one page at a time. However, if the contents of the collection |
| 352 | # change between the first and last paginated list request, the set of all |
| 353 | # elements returned will be an inconsistent view of the collection. There is |
| 354 | # no way to retrieve a consistent snapshot of a collection larger than the |
| 355 | # maximum page size. |
| 356 | "header": { # Elements common to every response. |
| 357 | "operationId": "A String", # For mutating operation requests that completed successfully. |
| 358 | # This is the client_operation_id if the client specified it, |
| 359 | # otherwise it is generated by the server (output only). |
| 360 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 361 | }</pre> |
| 362 | </div> |
| 363 | |
| 364 | <div class="method"> |
| 365 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 366 | <pre>Retrieves the next page of results. |
| 367 | |
| 368 | Args: |
| 369 | previous_request: The request for the previous page. (required) |
| 370 | previous_response: The response from the request for the previous page. (required) |
| 371 | |
| 372 | Returns: |
| 373 | A request object that you can call 'execute()' on to request the next |
| 374 | page. Returns None if there are no more items in the collection. |
| 375 | </pre> |
| 376 | </div> |
| 377 | |
| 378 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 379 | <code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code> |
| 380 | <pre>Apply a partial update to an existing Policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 381 | |
| 382 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 383 | project: string, Identifies the project addressed by this request. (required) |
| 384 | policy: string, User given friendly name of the policy addressed by this request. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 385 | body: object, The request body. |
| 386 | The object takes the form of: |
| 387 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 388 | { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 389 | # Cloud resources. |
| 390 | "kind": "dns#policy", |
| 391 | "name": "A String", # User assigned name for this policy. |
| 392 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 393 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 394 | { |
| 395 | "kind": "dns#policyNetwork", |
| 396 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 397 | # This should be formatted like |
| 398 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 399 | }, |
| 400 | ], |
| 401 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 402 | # for the user's convenience. Has no effect on the policy's function. |
| 403 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 404 | # Defaults to no logging if not set. |
| 405 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 406 | # applications over VPN connections. When enabled, a virtual IP address will |
| 407 | # be allocated from each of the sub-networks that are bound to this policy. |
| 408 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 409 | # specified, all DNS queries are forwarded to a name server that you |
| 410 | # choose. Names such as .internal are not available when an alternative |
| 411 | # name server is specified. |
| 412 | "kind": "dns#policyAlternativeNameServerConfig", |
| 413 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 414 | # specified, all DNS queries are forwarded to a name server that you |
| 415 | # choose. Names such as .internal are not available when an alternative |
| 416 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 417 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 418 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 419 | # Cloud DNS will make forwarding decision based on address ranges, |
| 420 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 421 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 422 | # through VPC for this target |
| 423 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 424 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | }, |
| 426 | ], |
| 427 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | } |
| 429 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 430 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 431 | specified by the client. Must be unique for operation resources in the |
| 432 | Operations collection. |
| 433 | x__xgafv: string, V1 error format. |
| 434 | Allowed values |
| 435 | 1 - v1 error format |
| 436 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 437 | |
| 438 | Returns: |
| 439 | An object of the form: |
| 440 | |
| 441 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 442 | "header": { # Elements common to every response. |
| 443 | "operationId": "A String", # For mutating operation requests that completed successfully. |
| 444 | # This is the client_operation_id if the client specified it, |
| 445 | # otherwise it is generated by the server (output only). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 446 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 447 | "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 448 | # Cloud resources. |
| 449 | "kind": "dns#policy", |
| 450 | "name": "A String", # User assigned name for this policy. |
| 451 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 452 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 453 | { |
| 454 | "kind": "dns#policyNetwork", |
| 455 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 456 | # This should be formatted like |
| 457 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 458 | }, |
| 459 | ], |
| 460 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 461 | # for the user's convenience. Has no effect on the policy's function. |
| 462 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 463 | # Defaults to no logging if not set. |
| 464 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 465 | # applications over VPN connections. When enabled, a virtual IP address will |
| 466 | # be allocated from each of the sub-networks that are bound to this policy. |
| 467 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 468 | # specified, all DNS queries are forwarded to a name server that you |
| 469 | # choose. Names such as .internal are not available when an alternative |
| 470 | # name server is specified. |
| 471 | "kind": "dns#policyAlternativeNameServerConfig", |
| 472 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 473 | # specified, all DNS queries are forwarded to a name server that you |
| 474 | # choose. Names such as .internal are not available when an alternative |
| 475 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 476 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 477 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 478 | # Cloud DNS will make forwarding decision based on address ranges, |
| 479 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 480 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 481 | # through VPC for this target |
| 482 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 483 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 484 | }, |
| 485 | ], |
| 486 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 487 | }, |
| 488 | }</pre> |
| 489 | </div> |
| 490 | |
| 491 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 492 | <code class="details" id="update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code> |
| 493 | <pre>Update an existing Policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 494 | |
| 495 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 496 | project: string, Identifies the project addressed by this request. (required) |
| 497 | policy: string, User given friendly name of the policy addressed by this request. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 498 | body: object, The request body. |
| 499 | The object takes the form of: |
| 500 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 501 | { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 502 | # Cloud resources. |
| 503 | "kind": "dns#policy", |
| 504 | "name": "A String", # User assigned name for this policy. |
| 505 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 506 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 507 | { |
| 508 | "kind": "dns#policyNetwork", |
| 509 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 510 | # This should be formatted like |
| 511 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 512 | }, |
| 513 | ], |
| 514 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 515 | # for the user's convenience. Has no effect on the policy's function. |
| 516 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 517 | # Defaults to no logging if not set. |
| 518 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 519 | # applications over VPN connections. When enabled, a virtual IP address will |
| 520 | # be allocated from each of the sub-networks that are bound to this policy. |
| 521 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 522 | # specified, all DNS queries are forwarded to a name server that you |
| 523 | # choose. Names such as .internal are not available when an alternative |
| 524 | # name server is specified. |
| 525 | "kind": "dns#policyAlternativeNameServerConfig", |
| 526 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 527 | # specified, all DNS queries are forwarded to a name server that you |
| 528 | # choose. Names such as .internal are not available when an alternative |
| 529 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 530 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 531 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 532 | # Cloud DNS will make forwarding decision based on address ranges, |
| 533 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 534 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 535 | # through VPC for this target |
| 536 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 537 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 538 | }, |
| 539 | ], |
| 540 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 541 | } |
| 542 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 543 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 544 | specified by the client. Must be unique for operation resources in the |
| 545 | Operations collection. |
| 546 | x__xgafv: string, V1 error format. |
| 547 | Allowed values |
| 548 | 1 - v1 error format |
| 549 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 550 | |
| 551 | Returns: |
| 552 | An object of the form: |
| 553 | |
| 554 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 555 | "header": { # Elements common to every response. |
| 556 | "operationId": "A String", # For mutating operation requests that completed successfully. |
| 557 | # This is the client_operation_id if the client specified it, |
| 558 | # otherwise it is generated by the server (output only). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 559 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 560 | "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private |
| 561 | # Cloud resources. |
| 562 | "kind": "dns#policy", |
| 563 | "name": "A String", # User assigned name for this policy. |
| 564 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 565 | "networks": [ # List of network names specifying networks to which this policy is applied. |
| 566 | { |
| 567 | "kind": "dns#policyNetwork", |
| 568 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 569 | # This should be formatted like |
| 570 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 571 | }, |
| 572 | ], |
| 573 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 574 | # for the user's convenience. Has no effect on the policy's function. |
| 575 | "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. |
| 576 | # Defaults to no logging if not set. |
| 577 | "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or |
| 578 | # applications over VPN connections. When enabled, a virtual IP address will |
| 579 | # be allocated from each of the sub-networks that are bound to this policy. |
| 580 | "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When |
| 581 | # specified, all DNS queries are forwarded to a name server that you |
| 582 | # choose. Names such as .internal are not available when an alternative |
| 583 | # name server is specified. |
| 584 | "kind": "dns#policyAlternativeNameServerConfig", |
| 585 | "targetNameServers": [ # Sets an alternative name server for the associated networks. When |
| 586 | # specified, all DNS queries are forwarded to a name server that you |
| 587 | # choose. Names such as .internal are not available when an alternative |
| 588 | # name server is specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 589 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 590 | "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, |
| 591 | # Cloud DNS will make forwarding decision based on address ranges, |
| 592 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 593 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 594 | # through VPC for this target |
| 595 | "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", |
| 596 | "ipv4Address": "A String", # IPv4 address to forward to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 597 | }, |
| 598 | ], |
| 599 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 600 | }, |
| 601 | }</pre> |
| 602 | </div> |
| 603 | |
| 604 | </body></html> |