blob: c880d6b2aaacb6b50cff19658a61bc4d18d0414f [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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 -070075<h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.policies.html">policies</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <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 -070081 <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070082<p class="firstline">Creates a new Policy.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070085<p class="firstline">Deletes a previously created Policy. Fails if the policy is still being referenced by a network.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#get">get(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080088<p class="firstline">Fetches the representation of an existing Policy.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080090 <code><a href="#list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080091<p class="firstline">Enumerates all Policies associated with a project.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<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 -070096 <code><a href="#patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070097<p class="firstline">Applies a partial update to an existing Policy.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070099 <code><a href="#update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700100<p class="firstline">Updates an existing Policy.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <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 -0700108 <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700109 <pre>Creates a new Policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700110
111Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700112 project: string, Identifies the project addressed by this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700113 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 The object takes the form of:
115
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700116{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800117 &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.
118 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
119 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700121 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800123 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800124 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 },
126 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800127 },
128 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700129 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 &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.
131 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
132 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800133 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800134 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
135 {
136 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
137 &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 Bot0bf565c2020-12-09 08:56:03 -0800138 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800139 ],
140}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700142 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 -0700143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700147
148Returns:
149 An object of the form:
150
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700151 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800152 &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.
153 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
154 &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.
155 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700156 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800158 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800159 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800160 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800161 ],
162 },
163 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700164 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800165 &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.
166 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
167 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800168 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800169 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
170 {
171 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
172 &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}
173 },
174 ],
175}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700176</div>
177
178<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700179 <code class="details" id="delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700180 <pre>Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181
182Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 project: string, Identifies the project addressed by this request. (required)
184 policy: string, User given friendly name of the policy addressed by this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 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 -0700186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700190</pre>
191</div>
192
193<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700194 <code class="details" id="get">get(project, policy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800195 <pre>Fetches the representation of an existing Policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700196
197Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700198 project: string, Identifies the project addressed by this request. (required)
199 policy: string, User given friendly name of the policy addressed by this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700200 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 -0700201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205
206Returns:
207 An object of the form:
208
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700209 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800210 &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.
211 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
212 &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.
213 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700214 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800215 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800216 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800217 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800218 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800219 ],
220 },
221 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700222 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800223 &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.
224 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
225 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800226 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800227 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
228 {
229 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
230 &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}
231 },
232 ],
233}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700234</div>
235
236<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800237 <code class="details" id="list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800238 <pre>Enumerates all Policies associated with a project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239
240Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700241 project: string, Identifies the project addressed by this request. (required)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800242 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800243 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 -0700244 x__xgafv: string, V1 error format.
245 Allowed values
246 1 - v1 error format
247 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248
249Returns:
250 An object of the form:
251
252 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800253 &quot;header&quot;: { # Elements common to every response.
254 &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).
255 },
256 &quot;kind&quot;: &quot;dns#policiesListResponse&quot;, # Type of resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700257 &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. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800258 &quot;policies&quot;: [ # The policy resources.
259 { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
260 &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.
261 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
262 &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.
263 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700264 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800265 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800266 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800267 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800268 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800269 ],
270 },
271 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700272 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800273 &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.
274 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
275 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800276 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800277 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
278 {
279 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
280 &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 Botc2228be2020-11-24 15:48:03 -0800281 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800282 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800283 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 ],
285}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700286</div>
287
288<div class="method">
289 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
290 <pre>Retrieves the next page of results.
291
292Args:
293 previous_request: The request for the previous page. (required)
294 previous_response: The response from the request for the previous page. (required)
295
296Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700297 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700298 page. Returns None if there are no more items in the collection.
299 </pre>
300</div>
301
302<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700303 <code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700304 <pre>Applies a partial update to an existing Policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700305
306Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700307 project: string, Identifies the project addressed by this request. (required)
308 policy: string, User given friendly name of the policy addressed by this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700309 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700310 The object takes the form of:
311
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700312{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800313 &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.
314 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700316 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700317 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800318 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800319 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800320 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700321 },
322 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800323 },
324 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700325 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800326 &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.
327 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
328 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800329 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800330 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
331 {
332 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
333 &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 Bot0bf565c2020-12-09 08:56:03 -0800334 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800335 ],
336}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700337
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700338 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 -0700339 x__xgafv: string, V1 error format.
340 Allowed values
341 1 - v1 error format
342 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700343
344Returns:
345 An object of the form:
346
347 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800348 &quot;header&quot;: { # Elements common to every response.
349 &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).
350 },
351 &quot;policy&quot;: { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
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;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
354 &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.
355 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700356 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800357 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800358 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800359 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800360 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800361 ],
362 },
363 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700364 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800365 &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.
366 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
367 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800368 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
370 {
371 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
372 &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 -0800373 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800374 ],
375 },
376}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700377</div>
378
379<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700380 <code class="details" id="update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700381 <pre>Updates an existing Policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700382
383Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700384 project: string, Identifies the project addressed by this request. (required)
385 policy: string, User given friendly name of the policy addressed by this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700386 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700387 The object takes the form of:
388
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700389{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800390 &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.
391 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
392 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700393 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700394 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800395 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800396 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800397 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700398 },
399 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800400 },
401 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700402 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800403 &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.
404 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
405 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800406 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800407 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
408 {
409 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
410 &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 Bot0bf565c2020-12-09 08:56:03 -0800411 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800412 ],
413}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700414
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700415 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 -0700416 x__xgafv: string, V1 error format.
417 Allowed values
418 1 - v1 error format
419 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700420
421Returns:
422 An object of the form:
423
424 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800425 &quot;header&quot;: { # Elements common to every response.
426 &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).
427 },
428 &quot;policy&quot;: { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
429 &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.
430 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;,
431 &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.
432 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700433 &quot;forwardingPath&quot;: &quot;A String&quot;, # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800434 &quot;ipv4Address&quot;: &quot;A String&quot;, # IPv4 address to forward to.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800435 &quot;ipv6Address&quot;: &quot;A String&quot;, # IPv6 address to forward to. Does not accept both fields (ipv4 &amp; ipv6) being populated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800436 &quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800437 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800438 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800439 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800440 &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700441 &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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800442 &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.
443 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
444 &quot;kind&quot;: &quot;dns#policy&quot;,
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800445 &quot;name&quot;: &quot;A String&quot;, # User-assigned name for this policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800446 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
447 {
448 &quot;kind&quot;: &quot;dns#policyNetwork&quot;,
449 &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}
450 },
451 ],
452 },
453}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700454</div>
455
456</body></html>