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

blob: 86159dd64c8243026e3f7647d1666ecc4c5ec345 [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>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	79	<p class="firstline">Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.</p>
				83	<p class="toc_element">
				84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<p class="firstline">Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	89	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	90	<code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	91	<p class="firstline">Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Returns metadata for a given CryptoKeyVersion.</p>
				95	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	96	<code><a href="#getPublicKey">getPublicKey(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<p class="firstline">Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	100	<p class="firstline">Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	101	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	102	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	103	<p class="firstline">Lists CryptoKeyVersions.</p>
				104	<p class="toc_element">
				105	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				106	<p class="firstline">Retrieves the next page of results.</p>
				107	<p class="toc_element">
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	108	<code><a href="#macSign">macSign(name, body=None, x__xgafv=None)</a></code></p>
				109	<p class="firstline">Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.</p>
				110	<p class="toc_element">
				111	<code><a href="#macVerify">macVerify(name, body=None, x__xgafv=None)</a></code></p>
				112	<p class="firstline">Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.</p>
				113	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	114	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	115	<p class="firstline">Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	116	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	118	<p class="firstline">Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	119	<h3>Method Details</h3>
				120	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	<code class="details" id="asymmetricDecrypt">asymmetricDecrypt(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	<pre>Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	123
				124	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	125	name: string, Required. The resource name of the CryptoKeyVersion to use for decryption. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	126	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127	The object takes the form of:
				128
				129	{ # Request message for KeyManagementService.AsymmetricDecrypt.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	130	"ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	131	"ciphertextCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	132	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	133
				134	x__xgafv: string, V1 error format.
				135	Allowed values
				136	1 - v1 error format
				137	2 - v2 error format
				138
				139	Returns:
				140	An object of the form:
				141
				142	{ # Response message for KeyManagementService.AsymmetricDecrypt.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	143	"plaintext": "A String", # The decrypted data originally encrypted with the matching public key.
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	144	"plaintextCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned AsymmetricDecryptResponse.plaintext. An integrity check of AsymmetricDecryptResponse.plaintext can be performed by computing the CRC32C checksum of AsymmetricDecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	145	"protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used in decryption.
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	146	"verifiedCiphertextCrc32c": True or False, # Integrity verification field. A flag indicating whether AsymmetricDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	147	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148	</div>
				149
				150	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	151	<code class="details" id="asymmetricSign">asymmetricSign(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	152	<pre>Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	153
				154	Args:
				155	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]	156	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	157	The object takes the form of:
				158
				159	{ # Request message for KeyManagementService.AsymmetricSign.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	160	"digest": { # A Digest holds a cryptographic message digest. # Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	161	"sha256": "A String", # A message digest produced with the SHA-256 algorithm.
				162	"sha384": "A String", # A message digest produced with the SHA-384 algorithm.
				163	"sha512": "A String", # A message digest produced with the SHA-512 algorithm.
				164	},
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	165	"digestCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricSignRequest.digest) is equal to AsymmetricSignRequest.digest_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	166	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	167
				168	x__xgafv: string, V1 error format.
				169	Allowed values
				170	1 - v1 error format
				171	2 - v2 error format
				172
				173	Returns:
				174	An object of the form:
				175
				176	{ # Response message for KeyManagementService.AsymmetricSign.
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	177	"name": "A String", # The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	178	"protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used for signing.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	179	"signature": "A String", # The created signature.
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	180	"signatureCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned AsymmetricSignResponse.signature. An integrity check of AsymmetricSignResponse.signature can be performed by computing the CRC32C checksum of AsymmetricSignResponse.signature and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
				181	"verifiedDigestCrc32c": True or False, # Integrity verification field. A flag indicating whether AsymmetricSignRequest.digest_crc32c was received by KeyManagementService and used for the integrity verification of the digest. A false value of this field indicates either that AsymmetricSignRequest.digest_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.digest_crc32c but this field is still false, discard the response and perform a limited number of retries.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	182	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	183	</div>
				184
				185	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	186	<code class="details" id="close">close()</code>
				187	<pre>Close httplib2 connections.</pre>
				188	</div>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	189
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	190	<div class="method">
				191	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				192	<pre>Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	193
				194	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	195	parent: string, Required. The name of the CryptoKey associated with the CryptoKeyVersions. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	196	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	197	The object takes the form of:
				198
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	200	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	201	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	202	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	203	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	204	"A String",
				205	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	206	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				207	"A String",
				208	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	209	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				210	"A String",
				211	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	212	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	213	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				214	"format": "A String", # Output only. The format of the attestation data.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	215	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	216	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	217	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				218	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	219	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				220	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				221	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	222	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	223	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				224	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				225	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	226	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				227	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	228	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	229	"state": "A String", # The current state of the CryptoKeyVersion.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	230	}
				231
				232	x__xgafv: string, V1 error format.
				233	Allowed values
				234	1 - v1 error format
				235	2 - v2 error format
				236
				237	Returns:
				238	An object of the form:
				239
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	240	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	241	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				242	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				243	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				244	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				245	"A String",
				246	],
				247	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				248	"A String",
				249	],
				250	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				251	"A String",
				252	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	253	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	254	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				255	"format": "A String", # Output only. The format of the attestation data.
				256	},
				257	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				258	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				259	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				260	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				261	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				262	},
				263	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	264	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				265	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				266	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	267	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				268	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	269	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	270	"state": "A String", # The current state of the CryptoKeyVersion.
				271	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	272	</div>
				273
				274	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	275	<code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	276	<pre>Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	277
				278	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	279	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]	280	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	281	The object takes the form of:
				282
				283	{ # Request message for KeyManagementService.DestroyCryptoKeyVersion.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	284	}
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	285
				286	x__xgafv: string, V1 error format.
				287	Allowed values
				288	1 - v1 error format
				289	2 - v2 error format
				290
				291	Returns:
				292	An object of the form:
				293
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	294	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	295	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				296	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				297	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				298	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				299	"A String",
				300	],
				301	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				302	"A String",
				303	],
				304	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				305	"A String",
				306	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	307	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	308	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				309	"format": "A String", # Output only. The format of the attestation data.
				310	},
				311	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				312	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				313	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				314	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				315	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				316	},
				317	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	318	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				319	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				320	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	321	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				322	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	323	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	324	"state": "A String", # The current state of the CryptoKeyVersion.
				325	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	326	</div>
				327
				328	<div class="method">
				329	<code class="details" id="get">get(name, x__xgafv=None)</code>
				330	<pre>Returns metadata for a given CryptoKeyVersion.
				331
				332	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	333	name: string, Required. The name of the CryptoKeyVersion to get. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	334	x__xgafv: string, V1 error format.
				335	Allowed values
				336	1 - v1 error format
				337	2 - v2 error format
				338
				339	Returns:
				340	An object of the form:
				341
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	342	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	343	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				344	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				345	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				346	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				347	"A String",
				348	],
				349	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				350	"A String",
				351	],
				352	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				353	"A String",
				354	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	355	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	356	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				357	"format": "A String", # Output only. The format of the attestation data.
				358	},
				359	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				360	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				361	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				362	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				363	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				364	},
				365	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	366	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				367	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				368	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	369	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				370	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	371	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	372	"state": "A String", # The current state of the CryptoKeyVersion.
				373	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	374	</div>
				375
				376	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377	<code class="details" id="getPublicKey">getPublicKey(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	378	<pre>Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	379
				380	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	381	name: string, Required. The name of the CryptoKeyVersion public key to get. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	382	x__xgafv: string, V1 error format.
				383	Allowed values
				384	1 - v1 error format
				385	2 - v2 error format
				386
				387	Returns:
				388	An object of the form:
				389
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	390	{ # The public key for a given CryptoKeyVersion. Obtained via GetPublicKey.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	391	"algorithm": "A String", # The Algorithm associated with this key.
				392	"name": "A String", # The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta.
				393	"pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).
				394	"pemCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	395	"protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion public key.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	396	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	397	</div>
				398
				399	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	<code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	401	<pre>Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	402
				403	Args:
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	404	parent: string, Required. The name of the CryptoKey to be imported into. The create permission is only required on this key when creating a new CryptoKeyVersion. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	405	body: object, The request body.
				406	The object takes the form of:
				407
				408	{ # Request message for KeyManagementService.ImportCryptoKeyVersion.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	409	"algorithm": "A String", # Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	410	"cryptoKeyVersion": "A String", # Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	411	"importJob": "A String", # Required. The name of the ImportJob that was used to wrap this key material.
				412	"rsaAesWrappedKey": "A String", # Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. 2. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.
				413	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	414
				415	x__xgafv: string, V1 error format.
				416	Allowed values
				417	1 - v1 error format
				418	2 - v2 error format
				419
				420	Returns:
				421	An object of the form:
				422
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	423	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	424	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				425	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				426	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				427	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				428	"A String",
				429	],
				430	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				431	"A String",
				432	],
				433	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				434	"A String",
				435	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	436	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	437	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				438	"format": "A String", # Output only. The format of the attestation data.
				439	},
				440	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				441	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				442	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				443	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				444	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				445	},
				446	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	447	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				448	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				449	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	450	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				451	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	452	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	453	"state": "A String", # The current state of the CryptoKeyVersion.
				454	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	455	</div>
				456
				457	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	458	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	459	<pre>Lists CryptoKeyVersions.
				460
				461	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	462	parent: string, Required. The resource name of the CryptoKey to list, in the format `projects//locations//keyRings//cryptoKeys/`. (required)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	463	filter: string, Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
				464	orderBy: string, Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	465	pageSize: integer, Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	466	pageToken: string, Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	467	view: string, The fields to include in the response.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	468	Allowed values
				469	CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED - Default view for each CryptoKeyVersion. Does not include the attestation field.
				470	FULL - Provides all fields in each CryptoKeyVersion, including the attestation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	471	x__xgafv: string, V1 error format.
				472	Allowed values
				473	1 - v1 error format
				474	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	475
				476	Returns:
				477	An object of the form:
				478
				479	{ # Response message for KeyManagementService.ListCryptoKeyVersions.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	480	"cryptoKeyVersions": [ # The list of CryptoKeyVersions.
				481	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
				482	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				483	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				484	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				485	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				486	"A String",
				487	],
				488	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				489	"A String",
				490	],
				491	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				492	"A String",
				493	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	494	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	495	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				496	"format": "A String", # Output only. The format of the attestation data.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	497	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	498	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				499	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				500	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				501	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				502	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				503	},
				504	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	505	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				506	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				507	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	508	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				509	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	510	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	511	"state": "A String", # The current state of the CryptoKeyVersion.
				512	},
				513	],
				514	"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results.
				515	"totalSize": 42, # The total number of CryptoKeyVersions that matched the query.
				516	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	517	</div>
				518
				519	<div class="method">
				520	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				521	<pre>Retrieves the next page of results.
				522
				523	Args:
				524	previous_request: The request for the previous page. (required)
				525	previous_response: The response from the request for the previous page. (required)
				526
				527	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	528	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	529	page. Returns None if there are no more items in the collection.
				530	</pre>
				531	</div>
				532
				533	<div class="method">
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	534	<code class="details" id="macSign">macSign(name, body=None, x__xgafv=None)</code>
				535	<pre>Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.
				536
				537	Args:
				538	name: string, Required. The resource name of the CryptoKeyVersion to use for signing. (required)
				539	body: object, The request body.
				540	The object takes the form of:
				541
				542	{ # Request message for KeyManagementService.MacSign.
				543	"data": "A String", # Required. The data to sign. The MAC tag is computed over this data field based on the specific algorithm.
				544	"dataCrc32c": "A String", # Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to MacSignRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
				545	}
				546
				547	x__xgafv: string, V1 error format.
				548	Allowed values
				549	1 - v1 error format
				550	2 - v2 error format
				551
				552	Returns:
				553	An object of the form:
				554
				555	{ # Response message for KeyManagementService.MacSign.
				556	"mac": "A String", # The created signature.
				557	"macCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
				558	"name": "A String", # The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing.
				559	"protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used for signing.
				560	"verifiedDataCrc32c": True or False, # Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.
				561	}</pre>
				562	</div>
				563
				564	<div class="method">
				565	<code class="details" id="macVerify">macVerify(name, body=None, x__xgafv=None)</code>
				566	<pre>Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.
				567
				568	Args:
				569	name: string, Required. The resource name of the CryptoKeyVersion to use for verification. (required)
				570	body: object, The request body.
				571	The object takes the form of:
				572
				573	{ # Request message for KeyManagementService.MacVerify.
				574	"data": "A String", # Required. The data used previously as a MacSignRequest.data to generate the MAC tag.
				575	"dataCrc32c": "A String", # Optional. An optional CRC32C checksum of the MacVerifyRequest.data. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.data) is equal to MacVerifyRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
				576	"mac": "A String", # Required. The signature to verify.
				577	"macCrc32c": "A String", # Optional. An optional CRC32C checksum of the MacVerifyRequest.mac. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.mac using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.tag) is equal to MacVerifyRequest.mac_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
				578	}
				579
				580	x__xgafv: string, V1 error format.
				581	Allowed values
				582	1 - v1 error format
				583	2 - v2 error format
				584
				585	Returns:
				586	An object of the form:
				587
				588	{ # Response message for KeyManagementService.MacVerify.
				589	"name": "A String", # The resource name of the CryptoKeyVersion used for verification. Check this field to verify that the intended resource was used for verification.
				590	"protectionLevel": "A String", # The ProtectionLevel of the CryptoKeyVersion used for verification.
				591	"success": True or False, # This field indicates whether or not the verification operation for MacVerifyRequest.mac over MacVerifyRequest.data was successful.
				592	"verifiedDataCrc32c": True or False, # Integrity verification field. A flag indicating whether MacVerifyRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacVerifyRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacVerifyRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.
				593	"verifiedMacCrc32c": True or False, # Integrity verification field. A flag indicating whether MacVerifyRequest.mac_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacVerifyRequest.mac_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacVerifyRequest.mac_crc32c but this field is still false, discard the response and perform a limited number of retries.
				594	"verifiedSuccessIntegrity": True or False, # Integrity verification field. This value is used for the integrity verification of [MacVerifyResponse.success]. If the value of this field contradicts the value of [MacVerifyResponse.success], discard the response and perform a limited number of retries.
				595	}</pre>
				596	</div>
				597
				598	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	599	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	600	<pre>Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	601
				602	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	603	name: string, Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	604	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	605	The object takes the form of:
				606
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	607	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	608	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	609	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	610	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	611	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	612	"A String",
				613	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	614	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				615	"A String",
				616	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	617	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				618	"A String",
				619	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	620	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	621	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				622	"format": "A String", # Output only. The format of the attestation data.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	623	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	624	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	625	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				626	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	627	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				628	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				629	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	630	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	631	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				632	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				633	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	634	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				635	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	636	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	637	"state": "A String", # The current state of the CryptoKeyVersion.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	638	}
				639
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	640	updateMask: string, Required. List of fields to be updated in this request.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	641	x__xgafv: string, V1 error format.
				642	Allowed values
				643	1 - v1 error format
				644	2 - v2 error format
				645
				646	Returns:
				647	An object of the form:
				648
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	649	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	650	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				651	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				652	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				653	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				654	"A String",
				655	],
				656	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				657	"A String",
				658	],
				659	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				660	"A String",
				661	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	662	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	663	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				664	"format": "A String", # Output only. The format of the attestation data.
				665	},
				666	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				667	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				668	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				669	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				670	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				671	},
				672	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	673	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				674	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				675	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	676	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				677	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	678	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	679	"state": "A String", # The current state of the CryptoKeyVersion.
				680	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	681	</div>
				682
				683	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	684	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	685	<pre>Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	686
				687	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	688	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]	689	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	690	The object takes the form of:
				691
				692	{ # Request message for KeyManagementService.RestoreCryptoKeyVersion.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	693	}
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	694
				695	x__xgafv: string, V1 error format.
				696	Allowed values
				697	1 - v1 error format
				698	2 - v2 error format
				699
				700	Returns:
				701	An object of the form:
				702
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	703	{ # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	704	"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
				705	"attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
				706	"certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
				707	"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
				708	"A String",
				709	],
				710	"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
				711	"A String",
				712	],
				713	"googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
				714	"A String",
				715	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	716	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	717	"content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
				718	"format": "A String", # Output only. The format of the attestation data.
				719	},
				720	"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
				721	"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
				722	"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
				723	"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.
				724	"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
				725	},
				726	"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	727	"importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
				728	"importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
				729	"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	730	"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
				731	"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
yoshi-code-bot	8bb904c	2021-08-31 00:28:27 -0700	[diff] [blame]	732	"reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	733	"state": "A String", # The current state of the CryptoKeyVersion.
				734	}</pre>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	735	</div>
				736
				737	</body></html>