Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 07d6b86e7c6a59d03c015d7df9b4c47a0b4e8d46 / . / docs / dyn / dns_v1beta2.responsePolicies.html
blob: fc7383a233b6ce8162ec45dc160bb880fe8cc47d [file] [log] [blame]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dns_v1beta2.html">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 -0700[diff] [blame]85<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 -0800[diff] [blame]86<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 -0700[diff] [blame]88<p class="firstline">Fetches the representation of an existing Response Policy.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]89<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 -0700[diff] [blame]91<p class="firstline">Enumerates all Response Policies associated with a project.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[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">
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 -0700[diff] [blame]97<p class="firstline">Applies a partial update to an existing Response Policy.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]98<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 -0700[diff] [blame]100<p class="firstline">Updates an existing Response Policy.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]101<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.
118 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
119 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
120 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
121 {
122 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
123 &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}
124 },
125 ],
126 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
127}
128
129 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
138 { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
139 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
140 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
141 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
142 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
143 {
144 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
145 &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}
146 },
147 ],
148 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
149}</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="delete">delete(project, responsePolicy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]154 <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 -0800[diff] [blame]155
156Args:
157 project: string, Identifies the project addressed by this request. (required)
158 responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
159 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="get">get(project, responsePolicy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]169 <pre>Fetches the representation of an existing Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]170
171Args:
172 project: string, Identifies the project addressed by this request. (required)
173 responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
174 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
183 { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
184 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
185 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
186 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
187 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
188 {
189 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
190 &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}
191 },
192 ],
193 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
194}</pre>
195</div>
196
197<div class="method">
198 <code class="details" id="list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]199 <pre>Enumerates all Response Policies associated with a project.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]200
201Args:
202 project: string, Identifies the project addressed by this request. (required)
203 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
204 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
213 {
214 &quot;header&quot;: { # Elements common to every response.
215 &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).
216 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]217 &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 -0800[diff] [blame]218 &quot;responsePolicies&quot;: [ # The Response Policy resources.
219 { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
220 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
221 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
222 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
223 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
224 {
225 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
226 &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}
227 },
228 ],
229 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
230 },
231 ],
232}</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
237 <pre>Retrieves the next page of results.
238
239Args:
240 previous_request: The request for the previous page. (required)
241 previous_response: The response from the request for the previous page. (required)
242
243Returns:
244 A request object that you can call &#x27;execute()&#x27; on to request the next
245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
249<div class="method">
250 <code class="details" id="patch">patch(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]251 <pre>Applies a partial update to an existing Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]252
253Args:
254 project: string, Identifies the project addressed by this request. (required)
255 responsePolicy: string, User assigned name of the Respones Policy addressed by this request. (required)
256 body: object, The request body.
257 The object takes the form of:
258
259{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
260 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
261 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
262 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
263 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
264 {
265 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
266 &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}
267 },
268 ],
269 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
270}
271
272 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
273 x__xgafv: string, V1 error format.
274 Allowed values
275 1 - v1 error format
276 2 - v2 error format
277
278Returns:
279 An object of the form:
280
281 {
282 &quot;header&quot;: { # Elements common to every response.
283 &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).
284 },
285 &quot;responsePolicy&quot;: { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
286 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
287 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
288 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
289 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
290 {
291 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
292 &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}
293 },
294 ],
295 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
296 },
297}</pre>
298</div>
299
300<div class="method">
301 <code class="details" id="update">update(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]302 <pre>Updates an existing Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]303
304Args:
305 project: string, Identifies the project addressed by this request. (required)
306 responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
307 body: object, The request body.
308 The object takes the form of:
309
310{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
311 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
312 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
313 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
314 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
315 {
316 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
317 &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}
318 },
319 ],
320 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
321}
322
323 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
324 x__xgafv: string, V1 error format.
325 Allowed values
326 1 - v1 error format
327 2 - v2 error format
328
329Returns:
330 An object of the form:
331
332 {
333 &quot;header&quot;: { # Elements common to every response.
334 &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).
335 },
336 &quot;responsePolicy&quot;: { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
337 &quot;description&quot;: &quot;A String&quot;, # User-provided description for this Response Policy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]338 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
339 &quot;kind&quot;: &quot;dns#responsePolicy&quot;,
340 &quot;networks&quot;: [ # List of network names specifying networks to which this policy is applied.
341 {
342 &quot;kind&quot;: &quot;dns#responsePolicyNetwork&quot;,
343 &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}
344 },
345 ],
346 &quot;responsePolicyName&quot;: &quot;A String&quot;, # User assigned name for this Response Policy.
347 },
348}</pre>
349</div>
350
351</body></html>