blob: 7df96799250e3a369e27fb87f576cceeb5d20e8b [file] [log] [blame]
<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">Google Cloud DNS API</a> . <a href="dns_v1.policies.html">policies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(project, body=None, clientOperationId=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#delete">delete(project, policy, clientOperationId=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#get">get(project, policy, clientOperationId=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, policy, body=None, clientOperationId=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#update">update(project, policy, body=None, clientOperationId=None)</a></code></p>
<p class="firstline"></p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(project, body=None, clientOperationId=None)</code>
<pre>
Args:
project: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
}
clientOperationId: string, A parameter
Returns:
An object of the form:
{
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, policy, clientOperationId=None)</code>
<pre>
Args:
project: string, A parameter (required)
policy: string, A parameter (required)
clientOperationId: string, A parameter
</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, policy, clientOperationId=None)</code>
<pre>
Args:
project: string, A parameter (required)
policy: string, A parameter (required)
clientOperationId: string, A parameter
Returns:
An object of the form:
{
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None)</code>
<pre>
Args:
project: string, A parameter (required)
maxResults: integer, A parameter
pageToken: string, A parameter
Returns:
An object of the form:
{
&quot;header&quot;: {
&quot;operationId&quot;: &quot;A String&quot;,
},
&quot;kind&quot;: &quot;dns#policiesListResponse&quot;, # Type of resource.
&quot;nextPageToken&quot;: &quot;A String&quot;,
&quot;policies&quot;: [
{
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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 &#x27;execute()&#x27; 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, policy, body=None, clientOperationId=None)</code>
<pre>
Args:
project: string, A parameter (required)
policy: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
}
clientOperationId: string, A parameter
Returns:
An object of the form:
{
&quot;header&quot;: {
&quot;operationId&quot;: &quot;A String&quot;,
},
&quot;policy&quot;: {
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, policy, body=None, clientOperationId=None)</code>
<pre>
Args:
project: string, A parameter (required)
policy: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
}
clientOperationId: string, A parameter
Returns:
An object of the form:
{
&quot;header&quot;: {
&quot;operationId&quot;: &quot;A String&quot;,
},
&quot;policy&quot;: {
&quot;alternativeNameServerConfig&quot;: {
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfig&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfig&quot;.
&quot;targetNameServers&quot;: [
{
&quot;forwardingPath&quot;: &quot;A String&quot;,
&quot;ipv4Address&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyAlternativeNameServerConfigTargetNameServer&quot;.
},
],
},
&quot;description&quot;: &quot;A String&quot;,
&quot;enableInboundForwarding&quot;: True or False,
&quot;enableLogging&quot;: True or False,
&quot;id&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;dns#policy&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policy&quot;.
&quot;name&quot;: &quot;A String&quot;,
&quot;networks&quot;: [
{
&quot;kind&quot;: &quot;dns#policyNetwork&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#policyNetwork&quot;.
&quot;networkUrl&quot;: &quot;A String&quot;,
},
],
},
}</pre>
</div>
</body></html>