Blame - docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html - platform/external/python/google-api-python-client

blob: ed628d983582d4dacbfb822bc6aa70ff636eabd9 [file] [log] [blame]

Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a> . <a href="cloudkms_v1.projects.locations.keyRings.html">keyRings</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.html">cryptoKeys</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html">cryptoKeyVersions</a></h1>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	78	<code><a href="#asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Decrypts data that was encrypted with a public key retrieved from</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	81	<code><a href="#asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Signs data using a CryptoKeyVersion with CryptoKey.purpose</p>
				83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	84	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	85	<p class="firstline">Create a new CryptoKeyVersion in a CryptoKey.</p>
				86	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	87	<code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	88	<p class="firstline">Schedule a CryptoKeyVersion for destruction.</p>
				89	<p class="toc_element">
				90	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Returns metadata for a given CryptoKeyVersion.</p>
				92	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	93	<code><a href="#getPublicKey">getPublicKey(name, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Returns the public key for the given CryptoKeyVersion. The</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	96	<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Imports a new CryptoKeyVersion into an existing CryptoKey using the</p>
				98	<p class="toc_element">
				99	<code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None, view=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	100	<p class="firstline">Lists CryptoKeyVersions.</p>
				101	<p class="toc_element">
				102	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				103	<p class="firstline">Retrieves the next page of results.</p>
				104	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	105	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	106	<p class="firstline">Update a CryptoKeyVersion's metadata.</p>
				107	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	109	<p class="firstline">Restore a CryptoKeyVersion in the</p>
				110	<h3>Method Details</h3>
				111	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	112	<code class="details" id="asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	<pre>Decrypts data that was encrypted with a public key retrieved from
				114	GetPublicKey corresponding to a CryptoKeyVersion with
				115	CryptoKey.purpose ASYMMETRIC_DECRYPT.
				116
				117	Args:
				118	name: string, Required. The resource name of the CryptoKeyVersion to use for
				119	decryption. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	120	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	The object takes the form of:
				122
				123	{ # Request message for KeyManagementService.AsymmetricDecrypt.
				124	"ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public
				125	# key using OAEP.
				126	}
				127
				128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
				132
				133	Returns:
				134	An object of the form:
				135
				136	{ # Response message for KeyManagementService.AsymmetricDecrypt.
				137	"plaintext": "A String", # The decrypted data originally encrypted with the matching public key.
				138	}</pre>
				139	</div>
				140
				141	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	142	<code class="details" id="asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	143	<pre>Signs data using a CryptoKeyVersion with CryptoKey.purpose
				144	ASYMMETRIC_SIGN, producing a signature that can be verified with the public
				145	key retrieved from GetPublicKey.
				146
				147	Args:
				148	name: string, Required. The resource name of the CryptoKeyVersion to use for signing. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	149	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	150	The object takes the form of:
				151
				152	{ # Request message for KeyManagementService.AsymmetricSign.
				153	"digest": { # A Digest holds a cryptographic message digest. # Required. The digest of the data to sign. The digest must be produced with
				154	# the same digest algorithm as specified by the key version's
				155	# algorithm.
				156	"sha256": "A String", # A message digest produced with the SHA-256 algorithm.
				157	"sha512": "A String", # A message digest produced with the SHA-512 algorithm.
				158	"sha384": "A String", # A message digest produced with the SHA-384 algorithm.
				159	},
				160	}
				161
				162	x__xgafv: string, V1 error format.
				163	Allowed values
				164	1 - v1 error format
				165	2 - v2 error format
				166
				167	Returns:
				168	An object of the form:
				169
				170	{ # Response message for KeyManagementService.AsymmetricSign.
				171	"signature": "A String", # The created signature.
				172	}</pre>
				173	</div>
				174
				175	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	176	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	177	<pre>Create a new CryptoKeyVersion in a CryptoKey.
				178
				179	The server will assign the next sequential id. If unset,
				180	state will be set to
				181	ENABLED.
				182
				183	Args:
				184	parent: string, Required. The name of the CryptoKey associated with
				185	the CryptoKeyVersions. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	186	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	187	The object takes the form of:
				188
				189	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				190	# associated key material.
				191	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	192	# An ENABLED version can be
				193	# used for cryptographic operations.
				194	#
				195	# For security reasons, the raw cryptographic key material represented by a
				196	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				197	# encrypt, decrypt, or sign data when an authorized user or application invokes
				198	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	199	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				200	# for destruction. Only present if state is
				201	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	202	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				203	# state is
				204	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	205	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				206	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	207	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				208	# performed with this CryptoKeyVersion.
				209	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				210	# creation time. Use this statement to verify attributes of the key as stored
				211	# on the HSM, independently of Google. Only provided for key versions with
				212	# protection_level HSM.
				213	# information, see [Verifying attestations]
				214	# (https://cloud.google.com/kms/docs/attest-key).
				215	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				216	# operation was performed.
				217	"format": "A String", # Output only. The format of the attestation data.
				218	},
				219	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	220	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				221	# CryptoKeyVersion. Only present if the underlying key material was
				222	# imported.
				223	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				224	# generated.
				225	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				226	# was imported.
				227	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				228	# CryptoKeyVersion supports.
				229	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				230	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				231	# configuring a CryptoKeyVersion that are specific to the
				232	# EXTERNAL protection level.
				233	# configuring a CryptoKeyVersion that are specific to the
				234	# EXTERNAL protection level.
				235	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				236	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	237	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				238	# destroyed. Only present if state is
				239	# DESTROYED.
				240	}
				241
				242	x__xgafv: string, V1 error format.
				243	Allowed values
				244	1 - v1 error format
				245	2 - v2 error format
				246
				247	Returns:
				248	An object of the form:
				249
				250	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				251	# associated key material.
				252	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	253	# An ENABLED version can be
				254	# used for cryptographic operations.
				255	#
				256	# For security reasons, the raw cryptographic key material represented by a
				257	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				258	# encrypt, decrypt, or sign data when an authorized user or application invokes
				259	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	260	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				261	# for destruction. Only present if state is
				262	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	263	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				264	# state is
				265	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	266	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				267	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	268	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				269	# performed with this CryptoKeyVersion.
				270	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				271	# creation time. Use this statement to verify attributes of the key as stored
				272	# on the HSM, independently of Google. Only provided for key versions with
				273	# protection_level HSM.
				274	# information, see [Verifying attestations]
				275	# (https://cloud.google.com/kms/docs/attest-key).
				276	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				277	# operation was performed.
				278	"format": "A String", # Output only. The format of the attestation data.
				279	},
				280	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	281	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				282	# CryptoKeyVersion. Only present if the underlying key material was
				283	# imported.
				284	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				285	# generated.
				286	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				287	# was imported.
				288	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				289	# CryptoKeyVersion supports.
				290	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				291	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				292	# configuring a CryptoKeyVersion that are specific to the
				293	# EXTERNAL protection level.
				294	# configuring a CryptoKeyVersion that are specific to the
				295	# EXTERNAL protection level.
				296	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				297	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	298	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				299	# destroyed. Only present if state is
				300	# DESTROYED.
				301	}</pre>
				302	</div>
				303
				304	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	305	<code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	306	<pre>Schedule a CryptoKeyVersion for destruction.
				307
				308	Upon calling this method, CryptoKeyVersion.state will be set to
				309	DESTROY_SCHEDULED
				310	and destroy_time will be set to a time 24
				311	hours in the future, at which point the state
				312	will be changed to
				313	DESTROYED, and the key
				314	material will be irrevocably destroyed.
				315
				316	Before the destroy_time is reached,
				317	RestoreCryptoKeyVersion may be called to reverse the process.
				318
				319	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	320	name: string, Required. The resource name of the CryptoKeyVersion to destroy. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	321	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	322	The object takes the form of:
				323
				324	{ # Request message for KeyManagementService.DestroyCryptoKeyVersion.
				325	}
				326
				327	x__xgafv: string, V1 error format.
				328	Allowed values
				329	1 - v1 error format
				330	2 - v2 error format
				331
				332	Returns:
				333	An object of the form:
				334
				335	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				336	# associated key material.
				337	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	338	# An ENABLED version can be
				339	# used for cryptographic operations.
				340	#
				341	# For security reasons, the raw cryptographic key material represented by a
				342	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				343	# encrypt, decrypt, or sign data when an authorized user or application invokes
				344	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	345	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				346	# for destruction. Only present if state is
				347	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	348	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				349	# state is
				350	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	351	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				352	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	353	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				354	# performed with this CryptoKeyVersion.
				355	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				356	# creation time. Use this statement to verify attributes of the key as stored
				357	# on the HSM, independently of Google. Only provided for key versions with
				358	# protection_level HSM.
				359	# information, see [Verifying attestations]
				360	# (https://cloud.google.com/kms/docs/attest-key).
				361	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				362	# operation was performed.
				363	"format": "A String", # Output only. The format of the attestation data.
				364	},
				365	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	366	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				367	# CryptoKeyVersion. Only present if the underlying key material was
				368	# imported.
				369	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				370	# generated.
				371	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				372	# was imported.
				373	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				374	# CryptoKeyVersion supports.
				375	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				376	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				377	# configuring a CryptoKeyVersion that are specific to the
				378	# EXTERNAL protection level.
				379	# configuring a CryptoKeyVersion that are specific to the
				380	# EXTERNAL protection level.
				381	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				382	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	383	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				384	# destroyed. Only present if state is
				385	# DESTROYED.
				386	}</pre>
				387	</div>
				388
				389	<div class="method">
				390	<code class="details" id="get">get(name, x__xgafv=None)</code>
				391	<pre>Returns metadata for a given CryptoKeyVersion.
				392
				393	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	394	name: string, Required. The name of the CryptoKeyVersion to get. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	395	x__xgafv: string, V1 error format.
				396	Allowed values
				397	1 - v1 error format
				398	2 - v2 error format
				399
				400	Returns:
				401	An object of the form:
				402
				403	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				404	# associated key material.
				405	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	406	# An ENABLED version can be
				407	# used for cryptographic operations.
				408	#
				409	# For security reasons, the raw cryptographic key material represented by a
				410	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				411	# encrypt, decrypt, or sign data when an authorized user or application invokes
				412	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	413	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				414	# for destruction. Only present if state is
				415	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	416	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				417	# state is
				418	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	419	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				420	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	421	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				422	# performed with this CryptoKeyVersion.
				423	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				424	# creation time. Use this statement to verify attributes of the key as stored
				425	# on the HSM, independently of Google. Only provided for key versions with
				426	# protection_level HSM.
				427	# information, see [Verifying attestations]
				428	# (https://cloud.google.com/kms/docs/attest-key).
				429	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				430	# operation was performed.
				431	"format": "A String", # Output only. The format of the attestation data.
				432	},
				433	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	434	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				435	# CryptoKeyVersion. Only present if the underlying key material was
				436	# imported.
				437	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				438	# generated.
				439	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				440	# was imported.
				441	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				442	# CryptoKeyVersion supports.
				443	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				444	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				445	# configuring a CryptoKeyVersion that are specific to the
				446	# EXTERNAL protection level.
				447	# configuring a CryptoKeyVersion that are specific to the
				448	# EXTERNAL protection level.
				449	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				450	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	451	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				452	# destroyed. Only present if state is
				453	# DESTROYED.
				454	}</pre>
				455	</div>
				456
				457	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	458	<code class="details" id="getPublicKey">getPublicKey(name, x__xgafv=None)</code>
				459	<pre>Returns the public key for the given CryptoKeyVersion. The
				460	CryptoKey.purpose must be
				461	ASYMMETRIC_SIGN or
				462	ASYMMETRIC_DECRYPT.
				463
				464	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	465	name: string, Required. The name of the CryptoKeyVersion public key to
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	466	get. (required)
				467	x__xgafv: string, V1 error format.
				468	Allowed values
				469	1 - v1 error format
				470	2 - v2 error format
				471
				472	Returns:
				473	An object of the form:
				474
				475	{ # The public key for a given CryptoKeyVersion. Obtained via
				476	# GetPublicKey.
				477	"pem": "A String", # The public key, encoded in PEM format. For more information, see the
				478	# [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for
				479	# [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and
				480	# [Textual Encoding of Subject Public Key Info]
				481	# (https://tools.ietf.org/html/rfc7468#section-13).
				482	"algorithm": "A String", # The Algorithm associated
				483	# with this key.
				484	}</pre>
				485	</div>
				486
				487	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	488	<code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
				489	<pre>Imports a new CryptoKeyVersion into an existing CryptoKey using the
				490	wrapped key material provided in the request.
				491
				492	The version ID will be assigned the next sequential id within the
				493	CryptoKey.
				494
				495	Args:
				496	parent: string, Required. The name of the CryptoKey to
				497	be imported into. (required)
				498	body: object, The request body.
				499	The object takes the form of:
				500
				501	{ # Request message for KeyManagementService.ImportCryptoKeyVersion.
				502	"importJob": "A String", # Required. The name of the ImportJob that was used to
				503	# wrap this key material.
				504	"algorithm": "A String", # Required. The algorithm of
				505	# the key being imported. This does not need to match the
				506	# version_template of the CryptoKey this
				507	# version imports into.
				508	"rsaAesWrappedKey": "A String", # Wrapped key material produced with
				509	# RSA_OAEP_3072_SHA1_AES_256
				510	# or
				511	# RSA_OAEP_4096_SHA1_AES_256.
				512	#
				513	# This field contains the concatenation of two wrapped keys:
				514	# <ol>
				515	# <li>An ephemeral AES-256 wrapping key wrapped with the
				516	# public_key using RSAES-OAEP with SHA-1,
				517	# MGF1 with SHA-1, and an empty label.
				518	# </li>
				519	# <li>The key to be imported, wrapped with the ephemeral AES-256 key
				520	# using AES-KWP (RFC 5649).
				521	# </li>
				522	# </ol>
				523	#
				524	# If importing symmetric key material, it is expected that the unwrapped
				525	# key contains plain bytes. If importing asymmetric key material, it is
				526	# expected that the unwrapped key is in PKCS#8-encoded DER format (the
				527	# PrivateKeyInfo structure from RFC 5208).
				528	#
				529	# This format is the same as the format produced by PKCS#11 mechanism
				530	# CKM_RSA_AES_KEY_WRAP.
				531	}
				532
				533	x__xgafv: string, V1 error format.
				534	Allowed values
				535	1 - v1 error format
				536	2 - v2 error format
				537
				538	Returns:
				539	An object of the form:
				540
				541	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				542	# associated key material.
				543	#
				544	# An ENABLED version can be
				545	# used for cryptographic operations.
				546	#
				547	# For security reasons, the raw cryptographic key material represented by a
				548	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				549	# encrypt, decrypt, or sign data when an authorized user or application invokes
				550	# Cloud KMS.
				551	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				552	# for destruction. Only present if state is
				553	# DESTROY_SCHEDULED.
				554	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				555	# state is
				556	# IMPORT_FAILED.
				557	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				558	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				559	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				560	# performed with this CryptoKeyVersion.
				561	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				562	# creation time. Use this statement to verify attributes of the key as stored
				563	# on the HSM, independently of Google. Only provided for key versions with
				564	# protection_level HSM.
				565	# information, see [Verifying attestations]
				566	# (https://cloud.google.com/kms/docs/attest-key).
				567	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				568	# operation was performed.
				569	"format": "A String", # Output only. The format of the attestation data.
				570	},
				571	"state": "A String", # The current state of the CryptoKeyVersion.
				572	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				573	# CryptoKeyVersion. Only present if the underlying key material was
				574	# imported.
				575	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				576	# generated.
				577	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				578	# was imported.
				579	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				580	# CryptoKeyVersion supports.
				581	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				582	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				583	# configuring a CryptoKeyVersion that are specific to the
				584	# EXTERNAL protection level.
				585	# configuring a CryptoKeyVersion that are specific to the
				586	# EXTERNAL protection level.
				587	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				588	},
				589	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				590	# destroyed. Only present if state is
				591	# DESTROYED.
				592	}</pre>
				593	</div>
				594
				595	<div class="method">
				596	<code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None, view=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	597	<pre>Lists CryptoKeyVersions.
				598
				599	Args:
				600	parent: string, Required. The resource name of the CryptoKey to list, in the format
				601	`projects//locations//keyRings//cryptoKeys/`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	602	orderBy: string, Optional. Specify how the results should be sorted. If not specified, the
				603	results will be sorted in the default order. For more information, see
				604	[Sorting and filtering list
				605	results](https://cloud.google.com/kms/docs/sorting-and-filtering).
				606	pageSize: integer, Optional. Optional limit on the number of CryptoKeyVersions to
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	607	include in the response. Further CryptoKeyVersions can
				608	subsequently be obtained by including the
				609	ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.
				610	If unspecified, the server will pick an appropriate default.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	611	pageToken: string, Optional. Optional pagination token, returned earlier via
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	612	ListCryptoKeyVersionsResponse.next_page_token.
				613	x__xgafv: string, V1 error format.
				614	Allowed values
				615	1 - v1 error format
				616	2 - v2 error format
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	617	filter: string, Optional. Only include resources that match the filter in the response. For
				618	more information, see
				619	[Sorting and filtering list
				620	results](https://cloud.google.com/kms/docs/sorting-and-filtering).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	621	view: string, The fields to include in the response.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	622
				623	Returns:
				624	An object of the form:
				625
				626	{ # Response message for KeyManagementService.ListCryptoKeyVersions.
				627	"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in
				628	# ListCryptoKeyVersionsRequest.page_token to retrieve the next page of
				629	# results.
				630	"totalSize": 42, # The total number of CryptoKeyVersions that matched the
				631	# query.
				632	"cryptoKeyVersions": [ # The list of CryptoKeyVersions.
				633	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				634	# associated key material.
				635	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	636	# An ENABLED version can be
				637	# used for cryptographic operations.
				638	#
				639	# For security reasons, the raw cryptographic key material represented by a
				640	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				641	# encrypt, decrypt, or sign data when an authorized user or application invokes
				642	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	643	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				644	# for destruction. Only present if state is
				645	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	646	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				647	# state is
				648	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	649	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				650	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	651	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				652	# performed with this CryptoKeyVersion.
				653	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				654	# creation time. Use this statement to verify attributes of the key as stored
				655	# on the HSM, independently of Google. Only provided for key versions with
				656	# protection_level HSM.
				657	# information, see [Verifying attestations]
				658	# (https://cloud.google.com/kms/docs/attest-key).
				659	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				660	# operation was performed.
				661	"format": "A String", # Output only. The format of the attestation data.
				662	},
				663	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	664	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				665	# CryptoKeyVersion. Only present if the underlying key material was
				666	# imported.
				667	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				668	# generated.
				669	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				670	# was imported.
				671	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				672	# CryptoKeyVersion supports.
				673	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				674	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				675	# configuring a CryptoKeyVersion that are specific to the
				676	# EXTERNAL protection level.
				677	# configuring a CryptoKeyVersion that are specific to the
				678	# EXTERNAL protection level.
				679	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				680	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	681	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				682	# destroyed. Only present if state is
				683	# DESTROYED.
				684	},
				685	],
				686	}</pre>
				687	</div>
				688
				689	<div class="method">
				690	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				691	<pre>Retrieves the next page of results.
				692
				693	Args:
				694	previous_request: The request for the previous page. (required)
				695	previous_response: The response from the request for the previous page. (required)
				696
				697	Returns:
				698	A request object that you can call 'execute()' on to request the next
				699	page. Returns None if there are no more items in the collection.
				700	</pre>
				701	</div>
				702
				703	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	704	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	705	<pre>Update a CryptoKeyVersion's metadata.
				706
				707	state may be changed between
				708	ENABLED and
				709	DISABLED using this
				710	method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to
				711	move between other states.
				712
				713	Args:
				714	name: string, Output only. The resource name for this CryptoKeyVersion in the format
				715	`projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	716	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	717	The object takes the form of:
				718
				719	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				720	# associated key material.
				721	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	722	# An ENABLED version can be
				723	# used for cryptographic operations.
				724	#
				725	# For security reasons, the raw cryptographic key material represented by a
				726	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				727	# encrypt, decrypt, or sign data when an authorized user or application invokes
				728	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	729	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				730	# for destruction. Only present if state is
				731	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	732	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				733	# state is
				734	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	735	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				736	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	737	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				738	# performed with this CryptoKeyVersion.
				739	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				740	# creation time. Use this statement to verify attributes of the key as stored
				741	# on the HSM, independently of Google. Only provided for key versions with
				742	# protection_level HSM.
				743	# information, see [Verifying attestations]
				744	# (https://cloud.google.com/kms/docs/attest-key).
				745	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				746	# operation was performed.
				747	"format": "A String", # Output only. The format of the attestation data.
				748	},
				749	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	750	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				751	# CryptoKeyVersion. Only present if the underlying key material was
				752	# imported.
				753	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				754	# generated.
				755	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				756	# was imported.
				757	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				758	# CryptoKeyVersion supports.
				759	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				760	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				761	# configuring a CryptoKeyVersion that are specific to the
				762	# EXTERNAL protection level.
				763	# configuring a CryptoKeyVersion that are specific to the
				764	# EXTERNAL protection level.
				765	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				766	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	767	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				768	# destroyed. Only present if state is
				769	# DESTROYED.
				770	}
				771
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	772	updateMask: string, Required. List of fields to be updated in this request.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	773	x__xgafv: string, V1 error format.
				774	Allowed values
				775	1 - v1 error format
				776	2 - v2 error format
				777
				778	Returns:
				779	An object of the form:
				780
				781	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				782	# associated key material.
				783	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	784	# An ENABLED version can be
				785	# used for cryptographic operations.
				786	#
				787	# For security reasons, the raw cryptographic key material represented by a
				788	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				789	# encrypt, decrypt, or sign data when an authorized user or application invokes
				790	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	791	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				792	# for destruction. Only present if state is
				793	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	794	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				795	# state is
				796	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	797	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				798	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	799	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				800	# performed with this CryptoKeyVersion.
				801	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				802	# creation time. Use this statement to verify attributes of the key as stored
				803	# on the HSM, independently of Google. Only provided for key versions with
				804	# protection_level HSM.
				805	# information, see [Verifying attestations]
				806	# (https://cloud.google.com/kms/docs/attest-key).
				807	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				808	# operation was performed.
				809	"format": "A String", # Output only. The format of the attestation data.
				810	},
				811	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	812	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				813	# CryptoKeyVersion. Only present if the underlying key material was
				814	# imported.
				815	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				816	# generated.
				817	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				818	# was imported.
				819	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				820	# CryptoKeyVersion supports.
				821	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				822	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				823	# configuring a CryptoKeyVersion that are specific to the
				824	# EXTERNAL protection level.
				825	# configuring a CryptoKeyVersion that are specific to the
				826	# EXTERNAL protection level.
				827	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				828	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	829	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				830	# destroyed. Only present if state is
				831	# DESTROYED.
				832	}</pre>
				833	</div>
				834
				835	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	836	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	837	<pre>Restore a CryptoKeyVersion in the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	838	DESTROY_SCHEDULED
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	839	state.
				840
				841	Upon restoration of the CryptoKeyVersion, state
				842	will be set to DISABLED,
				843	and destroy_time will be cleared.
				844
				845	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	846	name: string, Required. The resource name of the CryptoKeyVersion to restore. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	847	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	848	The object takes the form of:
				849
				850	{ # Request message for KeyManagementService.RestoreCryptoKeyVersion.
				851	}
				852
				853	x__xgafv: string, V1 error format.
				854	Allowed values
				855	1 - v1 error format
				856	2 - v2 error format
				857
				858	Returns:
				859	An object of the form:
				860
				861	{ # A CryptoKeyVersion represents an individual cryptographic key, and the
				862	# associated key material.
				863	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	864	# An ENABLED version can be
				865	# used for cryptographic operations.
				866	#
				867	# For security reasons, the raw cryptographic key material represented by a
				868	# CryptoKeyVersion can never be viewed or exported. It can only be used to
				869	# encrypt, decrypt, or sign data when an authorized user or application invokes
				870	# Cloud KMS.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	871	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
				872	# for destruction. Only present if state is
				873	# DESTROY_SCHEDULED.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	874	"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
				875	# state is
				876	# IMPORT_FAILED.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	877	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
				878	# `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	879	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
				880	# performed with this CryptoKeyVersion.
				881	"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
				882	# creation time. Use this statement to verify attributes of the key as stored
				883	# on the HSM, independently of Google. Only provided for key versions with
				884	# protection_level HSM.
				885	# information, see [Verifying attestations]
				886	# (https://cloud.google.com/kms/docs/attest-key).
				887	"content": "A String", # Output only. The attestation data provided by the HSM when the key
				888	# operation was performed.
				889	"format": "A String", # Output only. The format of the attestation data.
				890	},
				891	"state": "A String", # The current state of the CryptoKeyVersion.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	892	"importJob": "A String", # Output only. The name of the ImportJob used to import this
				893	# CryptoKeyVersion. Only present if the underlying key material was
				894	# imported.
				895	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				896	# generated.
				897	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
				898	# was imported.
				899	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
				900	# CryptoKeyVersion supports.
				901	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				902	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
				903	# configuring a CryptoKeyVersion that are specific to the
				904	# EXTERNAL protection level.
				905	# configuring a CryptoKeyVersion that are specific to the
				906	# EXTERNAL protection level.
				907	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				908	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	909	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
				910	# destroyed. Only present if state is
				911	# DESTROYED.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	912	}</pre>
				913	</div>
				914
				915	</body></html>