Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / dns_v1.dnsKeys.html
blob: 96c58fd890205f34a7259290b409f8d6a20c5c9b [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.dnsKeys.html">dnsKeys</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]81 <code><a href="#get">get(project, managedZone, dnsKeyId, clientOperationId=None, digestType=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]82<p class="firstline">Fetch the representation of an existing DnsKey.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#list">list(project, managedZone, pageToken=None, digestType=None, maxResults=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Enumerate DnsKeys to a ResourceRecordSet collection.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]96 <code class="details" id="get">get(project, managedZone, dnsKeyId, clientOperationId=None, digestType=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97 <pre>Fetch the representation of an existing DnsKey.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98
99Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]100 project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]101 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 dnsKeyId: string, The identifier of the requested DnsKey. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]104 digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109
110Returns:
111 An object of the form:
112
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 { # A DNSSEC key pair.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 &quot;publicKey&quot;: &quot;A String&quot;, # Base64 encoded public half of this key. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]115 &quot;type&quot;: &quot;A String&quot;, # One of &quot;KEY_SIGNING&quot; or &quot;ZONE_SIGNING&quot;. 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.
116 &quot;kind&quot;: &quot;dns#dnsKey&quot;,
117 &quot;algorithm&quot;: &quot;A String&quot;, # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 &quot;keyTag&quot;: 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&#x27;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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]119 &quot;keyLength&quot;: 42, # Length of the key in bits. Specified at creation time then immutable.
120 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
121 &quot;isActive&quot;: 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 &quot;digests&quot;: [ # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 &quot;type&quot;: &quot;A String&quot;, # Specifies the algorithm used to calculate this digest.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 &quot;digest&quot;: &quot;A String&quot;, # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 },
127 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the resource&#x27;s function.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]129 &quot;creationTime&quot;: &quot;A String&quot;, # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 }</pre>
131</div>
132
133<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 <code class="details" id="list">list(project, managedZone, pageToken=None, digestType=None, maxResults=None, x__xgafv=None)</code>
135 <pre>Enumerate DnsKeys to a ResourceRecordSet collection.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
137Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]139 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
141 digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
142 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147
148Returns:
149 An object of the form:
150
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 { # The response to a request to enumerate DnsKeys in a ManagedZone.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &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. 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 &quot;snapshot&quot; of collections larger than the maximum page size.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]153 &quot;dnsKeys&quot;: [ # The requested resources.
154 { # A DNSSEC key pair.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 &quot;publicKey&quot;: &quot;A String&quot;, # Base64 encoded public half of this key. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]156 &quot;type&quot;: &quot;A String&quot;, # One of &quot;KEY_SIGNING&quot; or &quot;ZONE_SIGNING&quot;. 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.
157 &quot;kind&quot;: &quot;dns#dnsKey&quot;,
158 &quot;algorithm&quot;: &quot;A String&quot;, # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]159 &quot;keyTag&quot;: 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&#x27;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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]160 &quot;keyLength&quot;: 42, # Length of the key in bits. Specified at creation time then immutable.
161 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server (output only).
162 &quot;isActive&quot;: 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]163 &quot;digests&quot;: [ # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]165 &quot;type&quot;: &quot;A String&quot;, # Specifies the algorithm used to calculate this digest.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]166 &quot;digest&quot;: &quot;A String&quot;, # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 },
168 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]169 &quot;description&quot;: &quot;A String&quot;, # A mutable string of at most 1024 characters associated with this resource for the user&#x27;s convenience. Has no effect on the resource&#x27;s function.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]170 &quot;creationTime&quot;: &quot;A String&quot;, # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 },
172 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]173 &quot;kind&quot;: &quot;dns#dnsKeysListResponse&quot;, # Type of resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]174 &quot;header&quot;: { # Elements common to every response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 &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).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
182 <pre>Retrieves the next page of results.
183
184Args:
185 previous_request: The request for the previous page. (required)
186 previous_response: The response from the request for the previous page. (required)
187
188Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 page. Returns None if there are no more items in the collection.
191 </pre>
192</div>
193
194</body></html>