Blame - docs/dyn/dns_v1.dnsKeys.html - platform/external/python/google-api-python-client

blob: 78b41a2fd80bf3d84dc4fe386b0ed77949b4fb0f [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Bu Sun Kim	d059ad8	2020-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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	81	<code><a href="#get">get(project, managedZone, dnsKeyId, clientOperationId=None, digestType=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	82	<p class="firstline">Fetches the representation of an existing DnsKey.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	84	<code><a href="#list">list(project, managedZone, digestType=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	85	<p class="firstline">Enumerates DnsKeys to a ResourceRecordSet collection.</p>
Bu Sun Kim	715bd7f	2019-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 Frenkel	3e17f89	2020-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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	96	<code class="details" id="get">get(project, managedZone, dnsKeyId, clientOperationId=None, digestType=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	97	<pre>Fetches the representation of an existing DnsKey.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98
				99	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	100	project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim	673ec5c	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	102	dnsKeyId: string, The identifier of the requested DnsKey. (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[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 is computed and displayed.
Bu Sun Kim	d059ad8	2020-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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109
				110	Returns:
				111	An object of the form:
				112
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	113	{ # A DNSSEC key pair.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	114	"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
				115	"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
				116	"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.
				117	"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.
				118	{
				119	"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
				120	"type": "A String", # Specifies the algorithm used to calculate this digest.
				121	},
				122	],
				123	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	124	"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
				125	"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	126	"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.
				127	"kind": "dns#dnsKey",
				128	"publicKey": "A String", # Base64 encoded public half of this key. Output only.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	129	"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, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	130	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	131	</div>
				132
				133	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	134	<code class="details" id="list">list(project, managedZone, digestType=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	135	<pre>Enumerates DnsKeys to a ResourceRecordSet collection.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	136
				137	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	138	project: string, Identifies the project addressed by this request. (required)
Bu Sun Kim	673ec5c	2020-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)
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	140	digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed.
				141	maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	142	pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Bu Sun Kim	d059ad8	2020-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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147
				148	Returns:
				149	An object of the form:
				150
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	151	{ # The response to a request to enumerate DnsKeys in a ManagedZone.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	"dnsKeys": [ # The requested resources.
				153	{ # A DNSSEC key pair.
				154	"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
				155	"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
				156	"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
				157	"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.
				158	{
				159	"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
				160	"type": "A String", # Specifies the algorithm used to calculate this digest.
				161	},
				162	],
				163	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	164	"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
				165	"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	166	"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.
				167	"kind": "dns#dnsKey",
				168	"publicKey": "A String", # Base64 encoded public half of this key. Output only.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	169	"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, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	170	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	171	],
				172	"header": { # Elements common to every response.
				173	"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).
				174	},
				175	"kind": "dns#dnsKeysListResponse", # Type of resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	176	"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 are an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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
				184	Args:
				185	previous_request: The request for the previous page. (required)
				186	previous_response: The response from the request for the previous page. (required)
				187
				188	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	189	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-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>