1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.responsePolicies.html">responsePolicies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Response Policy</p>
<p class="toc_element">
<code><a href="#delete">delete(project, responsePolicy, clientOperationId=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#get">get(project, responsePolicy, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches the representation of an existing Response Policy.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enumerates all Response Policies associated with a project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Applies a partial update to an existing Response Policy.</p>
<p class="toc_element">
<code><a href="#update">update(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing Response Policy.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Creates a new Response Policy
Args:
project: string, Identifies the project addressed by this request. (required)
body: object, The request body.
The object takes the form of:
{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, responsePolicy, clientOperationId=None, x__xgafv=None)</code>
<pre>Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
Args:
project: string, Identifies the project addressed by this request. (required)
responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, responsePolicy, clientOperationId=None, x__xgafv=None)</code>
<pre>Fetches the representation of an existing Response Policy.
Args:
project: string, Identifies the project addressed by this request. (required)
responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Enumerates all Response Policies associated with a project.
Args:
project: string, Identifies the project addressed by this request. (required)
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
"responsePolicies": [ # The Response Policy resources.
{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Applies a partial update to an existing Response Policy.
Args:
project: string, Identifies the project addressed by this request. (required)
responsePolicy: string, User assigned name of the response policy addressed by this request. (required)
body: object, The request body.
The object takes the form of:
{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Updates an existing Response Policy.
Args:
project: string, Identifies the project addressed by this request. (required)
responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
body: object, The request body.
The object takes the form of:
{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
"description": "A String", # User-provided description for this Response Policy.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied.
{
"gkeClusterName": "A String", # 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
"kind": "dns#responsePolicyGKECluster",
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"kind": "dns#responsePolicy",
"labels": { # User labels.
"a_key": "A String",
},
"networks": [ # List of network names specifying networks to which this policy is applied.
{
"kind": "dns#responsePolicyNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`
},
],
"responsePolicyName": "A String", # User assigned name for this Response Policy.
},
}</pre>
</div>
</body></html>
|