• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_v1.html">Cloud DNS API</a> . <a href="dns_v1.resourceRecordSets.html">resourceRecordSets</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, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a new ResourceRecordSet.</p>
83<p class="toc_element">
84  <code><a href="#delete">delete(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a previously created ResourceRecordSet.</p>
86<p class="toc_element">
87  <code><a href="#get">get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Fetches the representation of an existing ResourceRecordSet.</p>
89<p class="toc_element">
90  <code><a href="#list">list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Enumerates ResourceRecordSets that you have created but not yet deleted.</p>
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, managedZone, name, type, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Applies a partial update to an existing ResourceRecordSet.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="close">close()</code>
101  <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105    <code class="details" id="create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
106  <pre>Creates a new ResourceRecordSet.
107
108Args:
109  project: string, Identifies the project addressed by this request. (required)
110  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
111  body: object, The request body.
112    The object takes the form of:
113
114{ # A unit of data that is returned by the DNS servers.
115  &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
116  &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
117  &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
118    &quot;A String&quot;,
119  ],
120  &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
121    &quot;A String&quot;,
122  ],
123  &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
124  &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
125}
126
127  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
128  x__xgafv: string, V1 error format.
129    Allowed values
130      1 - v1 error format
131      2 - v2 error format
132
133Returns:
134  An object of the form:
135
136    { # A unit of data that is returned by the DNS servers.
137  &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
138  &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
139  &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
140    &quot;A String&quot;,
141  ],
142  &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
143    &quot;A String&quot;,
144  ],
145  &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
146  &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
147}</pre>
148</div>
149
150<div class="method">
151    <code class="details" id="delete">delete(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</code>
152  <pre>Deletes a previously created ResourceRecordSet.
153
154Args:
155  project: string, Identifies the project addressed by this request. (required)
156  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
157  name: string, Fully qualified domain name. (required)
158  type: string, RRSet type. (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
165Returns:
166  An object of the form:
167
168    {
169}</pre>
170</div>
171
172<div class="method">
173    <code class="details" id="get">get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</code>
174  <pre>Fetches the representation of an existing ResourceRecordSet.
175
176Args:
177  project: string, Identifies the project addressed by this request. (required)
178  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
179  name: string, Fully qualified domain name. (required)
180  type: string, RRSet type. (required)
181  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
182  x__xgafv: string, V1 error format.
183    Allowed values
184      1 - v1 error format
185      2 - v2 error format
186
187Returns:
188  An object of the form:
189
190    { # A unit of data that is returned by the DNS servers.
191  &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
192  &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
193  &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
194    &quot;A String&quot;,
195  ],
196  &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
197    &quot;A String&quot;,
198  ],
199  &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
200  &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
201}</pre>
202</div>
203
204<div class="method">
205    <code class="details" id="list">list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)</code>
206  <pre>Enumerates ResourceRecordSets that you have created but not yet deleted.
207
208Args:
209  project: string, Identifies the project addressed by this request. (required)
210  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
211  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
212  name: string, Restricts the list to return only records with this fully qualified domain name.
213  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
214  type: string, Restricts the list to return only records of this type. If present, the &quot;name&quot; parameter must also be present.
215  x__xgafv: string, V1 error format.
216    Allowed values
217      1 - v1 error format
218      2 - v2 error format
219
220Returns:
221  An object of the form:
222
223    {
224  &quot;header&quot;: { # Elements common to every response.
225    &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).
226  },
227  &quot;kind&quot;: &quot;dns#resourceRecordSetsListResponse&quot;, # Type of resource.
228  &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 pagination token. This lets you retrieve complete contents of even larger 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 elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
229  &quot;rrsets&quot;: [ # The resource record set resources.
230    { # A unit of data that is returned by the DNS servers.
231      &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
232      &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
233      &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
234        &quot;A String&quot;,
235      ],
236      &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
237        &quot;A String&quot;,
238      ],
239      &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
240      &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
241    },
242  ],
243}</pre>
244</div>
245
246<div class="method">
247    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
248  <pre>Retrieves the next page of results.
249
250Args:
251  previous_request: The request for the previous page. (required)
252  previous_response: The response from the request for the previous page. (required)
253
254Returns:
255  A request object that you can call &#x27;execute()&#x27; on to request the next
256  page. Returns None if there are no more items in the collection.
257    </pre>
258</div>
259
260<div class="method">
261    <code class="details" id="patch">patch(project, managedZone, name, type, body=None, clientOperationId=None, x__xgafv=None)</code>
262  <pre>Applies a partial update to an existing ResourceRecordSet.
263
264Args:
265  project: string, Identifies the project addressed by this request. (required)
266  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
267  name: string, Fully qualified domain name. (required)
268  type: string, RRSet type. (required)
269  body: object, The request body.
270    The object takes the form of:
271
272{ # A unit of data that is returned by the DNS servers.
273  &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
274  &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
275  &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
276    &quot;A String&quot;,
277  ],
278  &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
279    &quot;A String&quot;,
280  ],
281  &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
282  &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
283}
284
285  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
286  x__xgafv: string, V1 error format.
287    Allowed values
288      1 - v1 error format
289      2 - v2 error format
290
291Returns:
292  An object of the form:
293
294    { # A unit of data that is returned by the DNS servers.
295  &quot;kind&quot;: &quot;dns#resourceRecordSet&quot;,
296  &quot;name&quot;: &quot;A String&quot;, # For example, www.example.com.
297  &quot;rrdatas&quot;: [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
298    &quot;A String&quot;,
299  ],
300  &quot;signatureRrdatas&quot;: [ # As defined in RFC 4034 (section 3.2).
301    &quot;A String&quot;,
302  ],
303  &quot;ttl&quot;: 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
304  &quot;type&quot;: &quot;A String&quot;, # The identifier of a supported record type. See the list of Supported DNS record types.
305}</pre>
306</div>
307
308</body></html>