Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / dns_v1.policies.html
blob: cc166a4f92b910a3c30fbcaad8620edad437ac91 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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
Bu Sun Kimd059ad82020-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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Create a new Policy</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Delete a previously created Policy. Will fail if the policy is still being referenced by a network.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#get">get(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Fetch the representation of an existing Policy.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90 <code><a href="#list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91<p class="firstline">Enumerate all Policies associated with a project.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 <code><a href="#patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Apply a partial update to an existing Policy.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code><a href="#update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Update an existing Policy.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
109 <pre>Create a new Policy
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110
111Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 body: object, The request body.
114 The object takes the form of:
115
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]117 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
118 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
119 &quot;enableInboundForwarding&quot;: 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.
120 &quot;kind&quot;: &quot;dns#policy&quot;,
121 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
122 &quot;alternativeNameServerConfig&quot;: { # 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.
123 &quot;targetNameServers&quot;: [ # 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.
124 {
125 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
126 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
127 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
128 },
129 ],
130 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
131 },
132 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
133 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]135 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
136 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]137 },
138 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]139 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]141 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146
147Returns:
148 An object of the form:
149
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]150 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]151 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
152 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
153 &quot;enableInboundForwarding&quot;: 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.
154 &quot;kind&quot;: &quot;dns#policy&quot;,
155 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
156 &quot;alternativeNameServerConfig&quot;: { # 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.
157 &quot;targetNameServers&quot;: [ # 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.
158 {
159 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
160 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
161 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
162 },
163 ],
164 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
165 },
166 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
167 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]169 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
170 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171 },
172 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]173 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174</div>
175
176<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]177 <code class="details" id="delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178 <pre>Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179
180Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]181 project: string, Identifies the project addressed by this request. (required)
182 policy: string, User given friendly name of the policy addressed by this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]183 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188</pre>
189</div>
190
191<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]192 <code class="details" id="get">get(project, policy, clientOperationId=None, x__xgafv=None)</code>
193 <pre>Fetch the representation of an existing Policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194
195Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]196 project: string, Identifies the project addressed by this request. (required)
197 policy: string, User given friendly name of the policy addressed by this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]198 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203
204Returns:
205 An object of the form:
206
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]207 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]208 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
209 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
210 &quot;enableInboundForwarding&quot;: 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.
211 &quot;kind&quot;: &quot;dns#policy&quot;,
212 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
213 &quot;alternativeNameServerConfig&quot;: { # 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.
214 &quot;targetNameServers&quot;: [ # 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.
215 {
216 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
217 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
218 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
219 },
220 ],
221 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
222 },
223 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
224 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]226 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
227 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 },
229 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]230 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231</div>
232
233<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]234 <code class="details" id="list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]235 <pre>Enumerate all Policies associated with a project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236
237Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 project: string, Identifies the project addressed by this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]239 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
240 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245
246Returns:
247 An object of the form:
248
249 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]250 &quot;header&quot;: { # Elements common to every response.
251 &quot;operationId&quot;: &quot;A String&quot;, # 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).
252 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]253 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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. 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]254 &quot;kind&quot;: &quot;dns#policiesListResponse&quot;, # Type of resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]255 &quot;policies&quot;: [ # The policy resources.
256 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]257 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
258 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
259 &quot;enableInboundForwarding&quot;: 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.
260 &quot;kind&quot;: &quot;dns#policy&quot;,
261 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
262 &quot;alternativeNameServerConfig&quot;: { # 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.
263 &quot;targetNameServers&quot;: [ # 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.
264 {
265 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
266 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
267 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
268 },
269 ],
270 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
271 },
272 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
273 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]274 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]275 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
276 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]277 },
278 ],
279 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]280 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
286 <pre>Retrieves the next page of results.
287
288Args:
289 previous_request: The request for the previous page. (required)
290 previous_response: The response from the request for the previous page. (required)
291
292Returns:
293 A request object that you can call &#x27;execute()&#x27; on to request the next
294 page. Returns None if there are no more items in the collection.
295 </pre>
296</div>
297
298<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]299 <code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
300 <pre>Apply a partial update to an existing Policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301
302Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]303 project: string, Identifies the project addressed by this request. (required)
304 policy: string, User given friendly name of the policy addressed by this request. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 body: object, The request body.
306 The object takes the form of:
307
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]308{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]309 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
310 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
311 &quot;enableInboundForwarding&quot;: 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.
312 &quot;kind&quot;: &quot;dns#policy&quot;,
313 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
314 &quot;alternativeNameServerConfig&quot;: { # 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.
315 &quot;targetNameServers&quot;: [ # 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.
316 {
317 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
318 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
319 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
320 },
321 ],
322 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
323 },
324 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
325 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]326 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]327 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
328 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]329 },
330 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]331 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]332
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]333 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]334 x__xgafv: string, V1 error format.
335 Allowed values
336 1 - v1 error format
337 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338
339Returns:
340 An object of the form:
341
342 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]343 &quot;header&quot;: { # Elements common to every response.
344 &quot;operationId&quot;: &quot;A String&quot;, # 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).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]345 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]346 &quot;policy&quot;: { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
347 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
348 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
349 &quot;enableInboundForwarding&quot;: 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.
350 &quot;kind&quot;: &quot;dns#policy&quot;,
351 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
352 &quot;alternativeNameServerConfig&quot;: { # 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.
353 &quot;targetNameServers&quot;: [ # 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.
354 {
355 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
356 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
357 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
358 },
359 ],
360 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
361 },
362 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
363 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
364 {
365 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
366 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
367 },
368 ],
369 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]370 }</pre>
371</div>
372
373<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]374 <code class="details" id="update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
375 <pre>Update an existing Policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]376
377Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]378 project: string, Identifies the project addressed by this request. (required)
379 policy: string, User given friendly name of the policy addressed by this request. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]380 body: object, The request body.
381 The object takes the form of:
382
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]383{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]384 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
385 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
386 &quot;enableInboundForwarding&quot;: 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.
387 &quot;kind&quot;: &quot;dns#policy&quot;,
388 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
389 &quot;alternativeNameServerConfig&quot;: { # 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 &quot;targetNameServers&quot;: [ # 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.
391 {
392 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
393 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
394 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
395 },
396 ],
397 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
398 },
399 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
400 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]401 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]402 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
403 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]404 },
405 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]406 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]407
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]408 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]409 x__xgafv: string, V1 error format.
410 Allowed values
411 1 - v1 error format
412 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]413
414Returns:
415 An object of the form:
416
417 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]418 &quot;header&quot;: { # Elements common to every response.
419 &quot;operationId&quot;: &quot;A String&quot;, # 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).
420 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]421 &quot;policy&quot;: { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]422 &quot;name&quot;: &quot;A String&quot;, # User assigned name for this policy.
423 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the policy&#x27;s function.
424 &quot;enableInboundForwarding&quot;: 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.
425 &quot;kind&quot;: &quot;dns#policy&quot;,
426 &quot;enableLogging&quot;: True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
427 &quot;alternativeNameServerConfig&quot;: { # 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.
428 &quot;targetNameServers&quot;: [ # 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.
429 {
430 &quot;forwardingPath&quot;: &quot;A String&quot;, # 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.
431 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
432 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
433 },
434 ],
435 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
436 },
437 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
438 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]439 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]440 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
441 &quot;networkUrl&quot;: &quot;A String&quot;, # 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}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]442 },
443 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]444 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]445 }</pre>
446</div>
447
448</body></html>