Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dns_v1beta2.policies.html
blob: fcf1fd242216678003cc1795446259f1547a5126 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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_v1beta2.html">Google Cloud DNS API</a> . <a href="dns_v1beta2.policies.html">policies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(project, body=None, clientOperationId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Create a new Policy</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, policy, clientOperationId=None)</a></code></p>
82<p class="firstline">Delete a previously created Policy. Will fail if the policy is still being referenced by a network.</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, policy, clientOperationId=None)</a></code></p>
85<p class="firstline">Fetch the representation of an existing Policy.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Enumerate all Policies associated with a project.</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<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#patch">patch(project, policy, body=None, clientOperationId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Apply a partial update to an existing Policy.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#update">update(project, policy, body=None, clientOperationId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Update an existing Policy.</p>
98<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]100 <code class="details" id="create">create(project, body=None, clientOperationId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 <pre>Create a new Policy
102
103Args:
104 project: string, Identifies the project addressed by this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 The object takes the form of:
107
108{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
109 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
110 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
111 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
112 {
113 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
116 },
117 ],
118 },
119 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
120 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
121 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
122 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
123 "networks": [ # List of network names specifying networks to which this policy is applied.
124 {
125 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
126 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
127 },
128 ],
129 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
130 "name": "A String", # User assigned name for this policy.
131}
132
133 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
134
135Returns:
136 An object of the form:
137
138 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
139 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
140 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
141 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
142 {
143 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
146 },
147 ],
148 },
149 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
150 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
151 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
152 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
153 "networks": [ # List of network names specifying networks to which this policy is applied.
154 {
155 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
156 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
157 },
158 ],
159 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
160 "name": "A String", # User assigned name for this policy.
161 }</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="delete">delete(project, policy, clientOperationId=None)</code>
166 <pre>Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
167
168Args:
169 project: string, Identifies the project addressed by this request. (required)
170 policy: string, User given friendly name of the policy addressed by this request. (required)
171 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
172</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="get">get(project, policy, clientOperationId=None)</code>
177 <pre>Fetch the representation of an existing Policy.
178
179Args:
180 project: string, Identifies the project addressed by this request. (required)
181 policy: string, User given friendly name of the policy addressed by this request. (required)
182 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
183
184Returns:
185 An object of the form:
186
187 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
188 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
189 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
190 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
191 {
192 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]193 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
195 },
196 ],
197 },
198 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
199 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
200 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
201 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
202 "networks": [ # List of network names specifying networks to which this policy is applied.
203 {
204 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
205 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
206 },
207 ],
208 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
209 "name": "A String", # User assigned name for this policy.
210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
215 <pre>Enumerate all Policies associated with a project.
216
217Args:
218 project: string, Identifies the project addressed by this request. (required)
219 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
220 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
221
222Returns:
223 An object of the form:
224
225 {
226 "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.
227 #
228 # In this way you can 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 will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
229 "header": { # Elements common to every response.
230 "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).
231 },
232 "kind": "dns#policiesListResponse", # Type of resource.
233 "policies": [ # The policy resources.
234 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
235 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
236 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
237 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
238 {
239 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]240 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
242 },
243 ],
244 },
245 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
246 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
247 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
248 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
249 "networks": [ # List of network names specifying networks to which this policy is applied.
250 {
251 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
252 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
253 },
254 ],
255 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
256 "name": "A String", # User assigned name for this policy.
257 },
258 ],
259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
264 <pre>Retrieves the next page of results.
265
266Args:
267 previous_request: The request for the previous page. (required)
268 previous_response: The response from the request for the previous page. (required)
269
270Returns:
271 A request object that you can call 'execute()' on to request the next
272 page. Returns None if there are no more items in the collection.
273 </pre>
274</div>
275
276<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]277 <code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 <pre>Apply a partial update to an existing Policy.
279
280Args:
281 project: string, Identifies the project addressed by this request. (required)
282 policy: string, User given friendly name of the policy addressed by this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]283 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 The object takes the form of:
285
286{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
287 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
288 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
289 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
290 {
291 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]292 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
294 },
295 ],
296 },
297 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
298 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
299 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
300 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
301 "networks": [ # List of network names specifying networks to which this policy is applied.
302 {
303 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
304 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
305 },
306 ],
307 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
308 "name": "A String", # User assigned name for this policy.
309}
310
311 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
312
313Returns:
314 An object of the form:
315
316 {
317 "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
318 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
319 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
320 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
321 {
322 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]323 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
325 },
326 ],
327 },
328 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
329 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
330 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
331 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
332 "networks": [ # List of network names specifying networks to which this policy is applied.
333 {
334 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
335 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
336 },
337 ],
338 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
339 "name": "A String", # User assigned name for this policy.
340 },
341 "header": { # Elements common to every response.
342 "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).
343 },
344 }</pre>
345</div>
346
347<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]348 <code class="details" id="update">update(project, policy, body=None, clientOperationId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 <pre>Update an existing Policy.
350
351Args:
352 project: string, Identifies the project addressed by this request. (required)
353 policy: string, User given friendly name of the policy addressed by this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 The object takes the form of:
356
357{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
358 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
359 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
360 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
361 {
362 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]363 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
365 },
366 ],
367 },
368 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
369 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
370 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
371 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
372 "networks": [ # List of network names specifying networks to which this policy is applied.
373 {
374 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
375 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
376 },
377 ],
378 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
379 "name": "A String", # User assigned name for this policy.
380}
381
382 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
383
384Returns:
385 An object of the form:
386
387 {
388 "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
389 "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
390 "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
391 "targetNameServers": [ # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
392 {
393 "ipv4Address": "A String", # IPv4 address to forward to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]395 "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
396 },
397 ],
398 },
399 "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
400 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
401 "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
402 "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
403 "networks": [ # List of network names specifying networks to which this policy is applied.
404 {
405 "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
406 "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
407 },
408 ],
409 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
410 "name": "A String", # User assigned name for this policy.
411 },
412 "header": { # Elements common to every response.
413 "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).
414 },
415 }</pre>
416</div>
417
418</body></html>