Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, 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 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, 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_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.managedZones.html">managedZones</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#create">create(project, body)</a></code></p>
     79 <p class="firstline">Create a new ManagedZone.</p>
     80 <p class="toc_element">
     81   <code><a href="#delete">delete(project, managedZone)</a></code></p>
     82 <p class="firstline">Delete a previously created ManagedZone.</p>
     83 <p class="toc_element">
     84   <code><a href="#get">get(project, managedZone)</a></code></p>
     85 <p class="firstline">Fetch the representation of an existing ManagedZone.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list(project, pageToken=None, maxResults=None, dnsName=None)</a></code></p>
     88 <p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</p>
     89 <p class="toc_element">
     90   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     91 <p class="firstline">Retrieves the next page of results.</p>
     92 <h3>Method Details</h3>
     93 <div class="method">
     94     <code class="details" id="create">create(project, body)</code>
     95   <pre>Create a new ManagedZone.
     96 
     97 Args:
     98   project: string, Identifies the project addressed by this request. (required)
     99   body: object, The request body. (required)
    100     The object takes the form of:
    101 
    102 { # 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.
    103     "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    104     "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.
    105     "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    106       "A String",
    107     ],
    108     "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    109     "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.
    110     "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    111     "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    112     "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
    113   }
    114 
    115 
    116 Returns:
    117   An object of the form:
    118 
    119     { # 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.
    120       "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    121       "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.
    122       "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    123         "A String",
    124       ],
    125       "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    126       "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.
    127       "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    128       "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    129       "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
    130     }</pre>
    131 </div>
    132 
    133 <div class="method">
    134     <code class="details" id="delete">delete(project, managedZone)</code>
    135   <pre>Delete a previously created ManagedZone.
    136 
    137 Args:
    138   project: string, Identifies the project addressed by this request. (required)
    139   managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
    140 </pre>
    141 </div>
    142 
    143 <div class="method">
    144     <code class="details" id="get">get(project, managedZone)</code>
    145   <pre>Fetch the representation of an existing ManagedZone.
    146 
    147 Args:
    148   project: string, Identifies the project addressed by this request. (required)
    149   managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
    150 
    151 Returns:
    152   An object of the form:
    153 
    154     { # 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.
    155       "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    156       "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.
    157       "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    158         "A String",
    159       ],
    160       "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    161       "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.
    162       "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    163       "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    164       "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
    165     }</pre>
    166 </div>
    167 
    168 <div class="method">
    169     <code class="details" id="list">list(project, pageToken=None, maxResults=None, dnsName=None)</code>
    170   <pre>Enumerate ManagedZones that have been created but not yet deleted.
    171 
    172 Args:
    173   project: string, Identifies the project addressed by this request. (required)
    174   pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
    175   maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
    176   dnsName: string, Restricts the list to return only zones with this domain name.
    177 
    178 Returns:
    179   An object of the form:
    180 
    181     {
    182     "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.
    183         #
    184         # 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.
    185     "kind": "dns#managedZonesListResponse", # Type of resource.
    186     "managedZones": [ # The managed zone resources.
    187       { # 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.
    188           "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
    189           "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.
    190           "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
    191             "A String",
    192           ],
    193           "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
    194           "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.
    195           "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
    196           "id": "A String", # Unique identifier for the resource; defined by the server (output only)
    197           "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
    198         },
    199     ],
    200   }</pre>
    201 </div>
    202 
    203 <div class="method">
    204     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    205   <pre>Retrieves the next page of results.
    206 
    207 Args:
    208   previous_request: The request for the previous page. (required)
    209   previous_response: The response from the request for the previous page. (required)
    210 
    211 Returns:
    212   A request object that you can call 'execute()' on to request the next
    213   page. Returns None if there are no more items in the collection.
    214     </pre>
    215 </div>
    216 
    217 </body></html>