blob: 2ec80685152a81f515487bd0f2eab47ffe5e6835 [file] [log] [blame]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -08001<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">Cloud DNS API</a> . <a href="dns_v1beta2.responsePolicies.html">responsePolicies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a new Response Policy</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, responsePolicy, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070085<p class="firstline">Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080086<p class="toc_element">
87 <code><a href="#get">get(project, responsePolicy, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070088<p class="firstline">Fetches the representation of an existing Response Policy.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080089<p class="toc_element">
90 <code><a href="#list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bota8b35b92021-03-31 13:33:30 -070091<p class="firstline">Enumerates all Response Policies associated with a project.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(project, responsePolicy, 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 Response Policy.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080098<p class="toc_element">
99 <code><a href="#update">update(project, responsePolicy, 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 Response Policy.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
108 <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
109 <pre>Creates a new Response Policy
110
111Args:
112 project: string, Identifies the project addressed by this request. (required)
113 body: object, The request body.
114 The object takes the form of:
115
116{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
117 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700118 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
119 {
120 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
121 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
122 },
123 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800124 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
125 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
126 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
127 {
128 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
129 &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}
130 },
131 ],
132 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
133}
134
135 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
145 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700146 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
147 {
148 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
149 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
150 },
151 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800152 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
153 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
154 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
155 {
156 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
157 &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}
158 },
159 ],
160 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
161}</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="delete">delete(project, responsePolicy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700166 <pre>Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800167
168Args:
169 project: string, Identifies the project addressed by this request. (required)
170 responsePolicy: string, User assigned name of the Response 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 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="get">get(project, responsePolicy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700181 <pre>Fetches the representation of an existing Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800182
183Args:
184 project: string, Identifies the project addressed by this request. (required)
185 responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
186 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
195 { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
196 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700197 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
198 {
199 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
200 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
201 },
202 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800203 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
204 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
205 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
206 {
207 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
208 &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}
209 },
210 ],
211 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
212}</pre>
213</div>
214
215<div class="method">
216 <code class="details" id="list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700217 <pre>Enumerates all Response Policies associated with a project.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800218
219Args:
220 project: string, Identifies the project addressed by this request. (required)
221 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
222 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228Returns:
229 An object of the form:
230
231 {
232 &quot;header&quot;: { # Elements common to every response.
233 &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).
234 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700235 &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-code-botb6dc1b92021-03-02 11:49:08 -0800236 &quot;responsePolicies&quot;: [ # The Response Policy resources.
237 { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
238 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700239 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
240 {
241 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
242 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
243 },
244 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800245 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
246 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
247 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
248 {
249 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
250 &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}
251 },
252 ],
253 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
254 },
255 ],
256}</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
261 <pre>Retrieves the next page of results.
262
263Args:
264 previous_request: The request for the previous page. (required)
265 previous_response: The response from the request for the previous page. (required)
266
267Returns:
268 A request object that you can call &#x27;execute()&#x27; on to request the next
269 page. Returns None if there are no more items in the collection.
270 </pre>
271</div>
272
273<div class="method">
274 <code class="details" id="patch">patch(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700275 <pre>Applies a partial update to an existing Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800276
277Args:
278 project: string, Identifies the project addressed by this request. (required)
279 responsePolicy: string, User assigned name of the Respones Policy addressed by this request. (required)
280 body: object, The request body.
281 The object takes the form of:
282
283{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
284 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700285 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
286 {
287 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
288 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
289 },
290 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800291 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
292 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
293 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
294 {
295 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
296 &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}
297 },
298 ],
299 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
300}
301
302 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
303 x__xgafv: string, V1 error format.
304 Allowed values
305 1 - v1 error format
306 2 - v2 error format
307
308Returns:
309 An object of the form:
310
311 {
312 &quot;header&quot;: { # Elements common to every response.
313 &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).
314 },
315 &quot;responsePolicy&quot;: { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
316 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700317 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
318 {
319 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
320 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
321 },
322 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800323 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
324 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
325 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
326 {
327 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&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}
329 },
330 ],
331 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
332 },
333}</pre>
334</div>
335
336<div class="method">
337 <code class="details" id="update">update(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700338 <pre>Updates an existing Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800339
340Args:
341 project: string, Identifies the project addressed by this request. (required)
342 responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
343 body: object, The request body.
344 The object takes the form of:
345
346{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
347 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700348 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
349 {
350 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
351 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
352 },
353 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800354 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
355 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
356 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
357 {
358 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
359 &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}
360 },
361 ],
362 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
363}
364
365 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
366 x__xgafv: string, V1 error format.
367 Allowed values
368 1 - v1 error format
369 2 - v2 error format
370
371Returns:
372 An object of the form:
373
374 {
375 &quot;header&quot;: { # Elements common to every response.
376 &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).
377 },
378 &quot;responsePolicy&quot;: { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
379 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700380 &quot;gkeClusters&quot;: [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
381 {
382 &quot;gkeClusterName&quot;: &quot;A String&quot;, # The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
383 &quot;kind&quot;: &quot;dns#responsePolicyGKECluster&quot;,
384 },
385 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800386 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
387 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
388 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
389 {
390 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
391 &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}
392 },
393 ],
394 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
395 },
396}</pre>
397</div>
398
399</body></html>