blob: e82fec869423b32d613a398a592b008db6e95885 [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_v1beta1.html">Google Cloud DNS API</a> . <a href="dns_v1beta1.managedZones.html">managedZones</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(project, body)</a></code></p>
<p class="firstline">Create a new ManagedZone.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, managedZone)</a></code></p>
<p class="firstline">Delete a previously created ManagedZone.</p>
<p class="toc_element">
<code><a href="#get">get(project, managedZone)</a></code></p>
<p class="firstline">Fetch the representation of an existing ManagedZone.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(project, body)</code>
<pre>Create a new ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
}
Returns:
An object of the form:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, managedZone)</code>
<pre>Delete a previously created ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, managedZone)</code>
<pre>Fetch the representation of an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
Returns:
An object of the form:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
<pre>Enumerate ManagedZones that have been created but not yet deleted.
Args:
project: string, Identifies the project addressed by this request. (required)
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
Returns:
An object of the form:
{
"nextPageToken": "A String", # 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.
#
# In this way you can retrieve 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 will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
"kind": "dns#managedZonesListResponse", # Type of resource.
"managedZones": [ # The managed zone resources.
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
},
],
}</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 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>