Skip to content

Update dns_v2beta1.dnsKeys.html #972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
caltrops6490 wants to merge 8 commits into from
Closed

Update dns_v2beta1.dnsKeys.html #972

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1075d21
updated CHANGELOG.md [ci skip]
release-please[bot] Jul 15, 2020
1fe9138
updated setup.cfg [ci skip]
release-please[bot] Jul 15, 2020
e6e7fad
updated setup.py
release-please[bot] Jul 15, 2020
5977f45
Update dns_v2beta1.dnsKeys.html
caltrops6490 Jul 16, 2020
a730630
Merge branch 'master' into master
caltrops6490 Jul 18, 2020
538286e
Update dns_v2beta1.dnskeys.html
caltrops6490 Jul 18, 2020
132edf6
Merge branch 'release-v1.10.0'
caltrops6490 Jul 20, 2020
1ca1caf
Update dns_v2beta1.dnsKeys.html
caltrops6490 Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 54 additions & 56 deletions docs/dyn/dns_v2beta1.dnskeys.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,91 +75,89 @@
<h1><a href="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.dnsKeys.html">dnsKeys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, managedZone, dnsKeyId, digestType=None, clientOperationId=None)</a></code></p>
<p class="firstline">Fetch the representation of an existing DnsKey.</p>
<code><a href="#get">get(project, managedZone, dnsKeyId, clientOperationId=None, digestType=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list">list(project, managedZone, pageToken=None, digestType=None, maxResults=None)</a></code></p>
<p class="firstline">Enumerate DnsKeys to a ResourceRecordSet collection.</p>
<code><a href="#list">list(project, managedZone, digestType=None, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline"></p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(project, managedZone, dnsKeyId, digestType=None, clientOperationId=None)</code>
<pre>Fetch the representation of an existing DnsKey.
<code class="details" id="get">get(project, managedZone, dnsKeyId, clientOperationId=None, digestType=None)</code>
<pre>

Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
dnsKeyId: string, The identifier of the requested DnsKey. (required)
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.
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
project: string, A parameter (required)
managedZone: string, A parameter (required)
dnsKeyId: string, A parameter (required)
clientOperationId: string, A parameter
digestType: string, A parameter

Returns:
An object of the form:

{ # A DNSSEC key pair.
"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.
"kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
"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.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"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.
"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.
{
&quot;algorithm&quot;: &quot;A String&quot;,
&quot;creationTime&quot;: &quot;A String&quot;,
&quot;description&quot;: &quot;A String&quot;,
&quot;digests&quot;: [
{
"type": "A String", # Specifies the algorithm used to calculate this digest.
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
&quot;digest&quot;: &quot;A String&quot;,
&quot;type&quot;: &quot;A String&quot;,
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"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.
&quot;id&quot;: &quot;A String&quot;,
&quot;isActive&quot;: True or False,
&quot;keyLength&quot;: 42,
&quot;keyTag&quot;: 42,
&quot;kind&quot;: &quot;dns#dnsKey&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#dnsKey&quot;.
&quot;publicKey&quot;: &quot;A String&quot;,
&quot;type&quot;: &quot;A String&quot;,
}</pre>
</div>

<div class="method">
<code class="details" id="list">list(project, managedZone, pageToken=None, digestType=None, maxResults=None)</code>
<pre>Enumerate DnsKeys to a ResourceRecordSet collection.
<code class="details" id="list">list(project, managedZone, digestType=None, maxResults=None, pageToken=None)</code>
<pre>

Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
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.
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
project: string, A parameter (required)
managedZone: string, A parameter (required)
digestType: string, A parameter
maxResults: integer, A parameter
pageToken: string, A parameter

Returns:
An object of the form:

{ # The response to a request to enumerate DnsKeys in a ManagedZone.
"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 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 "snapshot" of collections larger than the maximum page size.
"header": { # Elements common to every response.
"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).
},
"dnsKeys": [ # The requested resources.
{ # A DNSSEC key pair.
"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.
"kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
"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.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"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.
"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.
{
&quot;dnsKeys&quot;: [
{
&quot;algorithm&quot;: &quot;A String&quot;,
&quot;creationTime&quot;: &quot;A String&quot;,
&quot;description&quot;: &quot;A String&quot;,
&quot;digests&quot;: [
{
"type": "A String", # Specifies the algorithm used to calculate this digest.
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
&quot;digest&quot;: &quot;A String&quot;,
&quot;type&quot;: &quot;A String&quot;,
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"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.
&quot;id&quot;: &quot;A String&quot;,
&quot;isActive&quot;: True or False,
&quot;keyLength&quot;: 42,
&quot;keyTag&quot;: 42,
&quot;kind&quot;: &quot;dns#dnsKey&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dns#dnsKey&quot;.
&quot;publicKey&quot;: &quot;A String&quot;,
&quot;type&quot;: &quot;A String&quot;,
},
],
"kind": "dns#dnsKeysListResponse", # Type of resource.
&quot;header&quot;: {
&quot;operationId&quot;: &quot;A String&quot;,
},
&quot;kind&quot;: &quot;dns#dnsKeysListResponse&quot;, # Type of resource.
&quot;nextPageToken&quot;: &quot;A String&quot;,
}</pre>
</div>

Expand All @@ -172,7 +170,7 @@ <h3>Method Details</h3>
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call 'execute()' on to request the next
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
Expand Down