Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / dns_v1.managedZones.html
blob: 1deeb5ebeff0937174ba69e95e6e090f8b57a9c5 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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">Google Cloud DNS API</a> . <a href="dns_v1.managedZones.html">managedZones</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="#create">create(project, body, clientOperationId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]79<p class="firstline">Create a new ManagedZone.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]81 <code><a href="#delete">delete(project, managedZone, clientOperationId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]82<p class="firstline">Delete a previously created ManagedZone.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]84 <code><a href="#get">get(project, managedZone, clientOperationId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]85<p class="firstline">Fetch the representation of an existing ManagedZone.</p>
86<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87 <code><a href="#list">list(project, pageToken=None, maxResults=None, dnsName=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]92<p class="toc_element">
93 <code><a href="#patch">patch(project, managedZone, body, clientOperationId=None)</a></code></p>
94<p class="firstline">Apply a partial update to an existing ManagedZone.</p>
95<p class="toc_element">
96 <code><a href="#update">update(project, managedZone, body, clientOperationId=None)</a></code></p>
97<p class="firstline">Update an existing ManagedZone.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]100 <code class="details" id="create">create(project, body, clientOperationId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]101 <pre>Create a new ManagedZone.
102
103Args:
104 project: string, Identifies the project addressed by this request. (required)
105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]109 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
110 "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.
111 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
112 "A String",
113 ],
114 "labels": { # User labels.
115 "a_key": "A String",
116 },
117 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
118 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
119 "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.
120 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
121 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
122 "networks": [ # The list of VPC networks that can see this zone.
123 {
124 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
125 "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}
126 },
127 ],
128 },
129 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
130 "dnssecConfig": { # DNSSEC configuration.
131 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
132 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
133 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
134 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
135 "keyLength": 42, # Length of the keys in bits.
136 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
137 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
138 },
139 ],
140 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
141 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
142 },
143 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
144 "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.
145}
146
147 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
148
149Returns:
150 An object of the form:
151
152 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]153 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
154 "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.
155 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
156 "A String",
157 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]158 "labels": { # User labels.
159 "a_key": "A String",
160 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]161 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]162 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]163 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]164 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
165 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
166 "networks": [ # The list of VPC networks that can see this zone.
167 {
168 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
169 "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}
170 },
171 ],
172 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]173 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]174 "dnssecConfig": { # DNSSEC configuration.
175 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
176 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
177 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
178 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
179 "keyLength": 42, # Length of the keys in bits.
180 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
181 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
182 },
183 ],
184 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
185 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
186 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]188 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]189 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]190</div>
191
192<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]193 <code class="details" id="delete">delete(project, managedZone, clientOperationId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]194 <pre>Delete a previously created ManagedZone.
195
196Args:
197 project: string, Identifies the project addressed by this request. (required)
198 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]199 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]200</pre>
201</div>
202
203<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]204 <code class="details" id="get">get(project, managedZone, clientOperationId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]205 <pre>Fetch the representation of an existing ManagedZone.
206
207Args:
208 project: string, Identifies the project addressed by this request. (required)
209 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]210 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]211
212Returns:
213 An object of the form:
214
215 { # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]216 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
217 "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.
218 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
219 "A String",
220 ],
221 "labels": { # User labels.
222 "a_key": "A String",
223 },
224 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
225 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
226 "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.
227 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
228 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
229 "networks": [ # The list of VPC networks that can see this zone.
230 {
231 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
232 "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}
233 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]234 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]235 },
236 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
237 "dnssecConfig": { # DNSSEC configuration.
238 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
239 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
240 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
241 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
242 "keyLength": 42, # Length of the keys in bits.
243 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
244 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
245 },
246 ],
247 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
248 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
249 },
250 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
251 "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.
252 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]253</div>
254
255<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]256 <code class="details" id="list">list(project, pageToken=None, maxResults=None, dnsName=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]257 <pre>Enumerate ManagedZones that have been created but not yet deleted.
258
259Args:
260 project: string, Identifies the project addressed by this request. (required)
261 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
262 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]263 dnsName: string, Restricts the list to return only zones with this domain name.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]264
265Returns:
266 An object of the form:
267
268 {
269 "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.
270 #
271 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]272 "header": { # Elements common to every response.
273 "operationId": "A String", # 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).
274 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]275 "kind": "dns#managedZonesListResponse", # Type of resource.
276 "managedZones": [ # The managed zone resources.
277 { # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]278 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
279 "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.
280 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
281 "A String",
282 ],
283 "labels": { # User labels.
284 "a_key": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]285 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]286 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
287 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
288 "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.
289 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
290 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
291 "networks": [ # The list of VPC networks that can see this zone.
292 {
293 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
294 "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}
295 },
296 ],
297 },
298 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
299 "dnssecConfig": { # DNSSEC configuration.
300 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
301 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
302 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
303 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
304 "keyLength": 42, # Length of the keys in bits.
305 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
306 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
307 },
308 ],
309 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
310 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
311 },
312 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
313 "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.
314 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]315 ],
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
321 <pre>Retrieves the next page of results.
322
323Args:
324 previous_request: The request for the previous page. (required)
325 previous_response: The response from the request for the previous page. (required)
326
327Returns:
328 A request object that you can call 'execute()' on to request the next
329 page. Returns None if there are no more items in the collection.
330 </pre>
331</div>
332
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]333<div class="method">
334 <code class="details" id="patch">patch(project, managedZone, body, clientOperationId=None)</code>
335 <pre>Apply a partial update to an existing ManagedZone.
336
337Args:
338 project: string, Identifies the project addressed by this request. (required)
339 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
340 body: object, The request body. (required)
341 The object takes the form of:
342
343{ # 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.
344 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
345 "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.
346 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
347 "A String",
348 ],
349 "labels": { # User labels.
350 "a_key": "A String",
351 },
352 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
353 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
354 "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.
355 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
356 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
357 "networks": [ # The list of VPC networks that can see this zone.
358 {
359 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
360 "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}
361 },
362 ],
363 },
364 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
365 "dnssecConfig": { # DNSSEC configuration.
366 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
367 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
368 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
369 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
370 "keyLength": 42, # Length of the keys in bits.
371 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
372 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
373 },
374 ],
375 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
376 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
377 },
378 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
379 "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.
380}
381
382 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
383
384Returns:
385 An object of the form:
386
387 { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
388 "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
389 "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
390 "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
391 "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
392 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
393 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
394 "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 resource's function.
395 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
396 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
397 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
398 "publicKey": "A String", # Base64 encoded public half of this key. Output only.
399 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
400 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
401 {
402 "type": "A String", # Specifies the algorithm used to calculate this digest.
403 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
404 },
405 ],
406 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
407 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
408 },
409 "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
410 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
411 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
412 "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 resource's function.
413 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
414 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
415 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
416 "publicKey": "A String", # Base64 encoded public half of this key. Output only.
417 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
418 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
419 {
420 "type": "A String", # Specifies the algorithm used to calculate this digest.
421 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
422 },
423 ],
424 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
425 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
426 },
427 },
428 "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
429 "newValue": { # 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. # The post-operation ManagedZone resource.
430 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
431 "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.
432 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
433 "A String",
434 ],
435 "labels": { # User labels.
436 "a_key": "A String",
437 },
438 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
439 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
440 "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.
441 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
442 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
443 "networks": [ # The list of VPC networks that can see this zone.
444 {
445 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
446 "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}
447 },
448 ],
449 },
450 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
451 "dnssecConfig": { # DNSSEC configuration.
452 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
453 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
454 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
455 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
456 "keyLength": 42, # Length of the keys in bits.
457 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
458 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
459 },
460 ],
461 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
462 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
463 },
464 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
465 "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.
466 },
467 "oldValue": { # 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. # The pre-operation ManagedZone resource.
468 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
469 "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.
470 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
471 "A String",
472 ],
473 "labels": { # User labels.
474 "a_key": "A String",
475 },
476 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
477 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
478 "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.
479 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
480 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
481 "networks": [ # The list of VPC networks that can see this zone.
482 {
483 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
484 "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}
485 },
486 ],
487 },
488 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
489 "dnssecConfig": { # DNSSEC configuration.
490 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
491 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
492 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
493 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
494 "keyLength": 42, # Length of the keys in bits.
495 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
496 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
497 },
498 ],
499 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
500 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
501 },
502 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
503 "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.
504 },
505 },
506 "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
507 "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
508 "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
509 "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
510 }</pre>
511</div>
512
513<div class="method">
514 <code class="details" id="update">update(project, managedZone, body, clientOperationId=None)</code>
515 <pre>Update an existing ManagedZone.
516
517Args:
518 project: string, Identifies the project addressed by this request. (required)
519 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
520 body: object, The request body. (required)
521 The object takes the form of:
522
523{ # 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.
524 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
525 "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.
526 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
527 "A String",
528 ],
529 "labels": { # User labels.
530 "a_key": "A String",
531 },
532 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
533 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
534 "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.
535 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
536 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
537 "networks": [ # The list of VPC networks that can see this zone.
538 {
539 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
540 "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}
541 },
542 ],
543 },
544 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
545 "dnssecConfig": { # DNSSEC configuration.
546 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
547 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
548 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
549 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
550 "keyLength": 42, # Length of the keys in bits.
551 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
552 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
553 },
554 ],
555 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
556 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
557 },
558 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
559 "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.
560}
561
562 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
563
564Returns:
565 An object of the form:
566
567 { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
568 "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
569 "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
570 "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
571 "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
572 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
573 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
574 "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 resource's function.
575 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
576 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
577 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
578 "publicKey": "A String", # Base64 encoded public half of this key. Output only.
579 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
580 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
581 {
582 "type": "A String", # Specifies the algorithm used to calculate this digest.
583 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
584 },
585 ],
586 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
587 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
588 },
589 "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
590 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
591 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
592 "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 resource's function.
593 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
594 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
595 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
596 "publicKey": "A String", # Base64 encoded public half of this key. Output only.
597 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
598 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
599 {
600 "type": "A String", # Specifies the algorithm used to calculate this digest.
601 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
602 },
603 ],
604 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
605 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
606 },
607 },
608 "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
609 "newValue": { # 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. # The post-operation ManagedZone resource.
610 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
611 "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.
612 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
613 "A String",
614 ],
615 "labels": { # User labels.
616 "a_key": "A String",
617 },
618 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
619 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
620 "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.
621 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
622 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
623 "networks": [ # The list of VPC networks that can see this zone.
624 {
625 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
626 "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}
627 },
628 ],
629 },
630 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
631 "dnssecConfig": { # DNSSEC configuration.
632 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
633 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
634 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
635 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
636 "keyLength": 42, # Length of the keys in bits.
637 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
638 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
639 },
640 ],
641 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
642 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
643 },
644 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
645 "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.
646 },
647 "oldValue": { # 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. # The pre-operation ManagedZone resource.
648 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
649 "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.
650 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
651 "A String",
652 ],
653 "labels": { # User labels.
654 "a_key": "A String",
655 },
656 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
657 "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
658 "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.
659 "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
660 "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig".
661 "networks": [ # The list of VPC networks that can see this zone.
662 {
663 "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork".
664 "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}
665 },
666 ],
667 },
668 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
669 "dnssecConfig": { # DNSSEC configuration.
670 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
671 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
672 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
673 "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
674 "keyLength": 42, # Length of the keys in bits.
675 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
676 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
677 },
678 ],
679 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
680 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
681 },
682 "id": "A String", # Unique identifier for the resource; defined by the server (output only)
683 "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.
684 },
685 },
686 "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
687 "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
688 "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
689 "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
690 }</pre>
691</div>
692
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]693</body></html>