docs: update generated docs (#981)
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
index 6f6ba0f..351933d 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
@@ -96,7 +96,7 @@
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Imports a new CryptoKeyVersion into an existing CryptoKey using the</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, view=None, orderBy=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists CryptoKeyVersions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -121,6 +121,21 @@
The object takes the form of:
{ # Request message for KeyManagementService.AsymmetricDecrypt.
+ "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.
+ #
+ # NOTE: This field is in Beta.
"ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public
# key using OAEP.
}
@@ -135,6 +150,29 @@
{ # Response message for KeyManagementService.AsymmetricDecrypt.
"plaintext": "A String", # The decrypted data originally encrypted with the matching public key.
+ "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.
+ #
+ # NOTE: This field is in Beta.
+ "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.
+ #
+ # NOTE: This field is in Beta.
}</pre>
</div>
@@ -153,10 +191,25 @@
"digest": { # A Digest holds a cryptographic message digest. # Required. 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.
- "sha512": "A String", # A message digest produced with the SHA-512 algorithm.
"sha384": "A String", # A message digest produced with the SHA-384 algorithm.
"sha256": "A String", # A message digest produced with the SHA-256 algorithm.
+ "sha512": "A String", # A message digest produced with the SHA-512 algorithm.
},
+ "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.
+ #
+ # NOTE: This field is in Beta.
}
x__xgafv: string, V1 error format.
@@ -168,7 +221,34 @@
An object of the form:
{ # Response message for KeyManagementService.AsymmetricSign.
+ "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.
+ #
+ # NOTE: This field is in Beta.
+ "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.
+ #
+ # NOTE: This field is in Beta.
"signature": "A String", # The created signature.
+ "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.
+ #
+ # NOTE: This field is in Beta.
}</pre>
</div>
@@ -196,33 +276,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -233,10 +296,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}
x__xgafv: string, V1 error format.
@@ -257,33 +337,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -294,10 +357,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}</pre>
</div>
@@ -342,33 +422,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -379,10 +442,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}</pre>
</div>
@@ -410,33 +490,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -447,10 +510,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}</pre>
</div>
@@ -474,6 +554,23 @@
{ # The public key for a given CryptoKeyVersion. Obtained via
# GetPublicKey.
+ "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.
+ "name": "A String", # The name of the CryptoKeyVersion public key.
+ # Provided here for verification.
+ #
+ # NOTE: This field is in Beta.
"algorithm": "A String", # The Algorithm associated
# with this key.
"pem": "A String", # The public key, encoded in PEM format. For more information, see the
@@ -548,33 +645,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -585,15 +665,32 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, view=None, orderBy=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
<pre>Lists CryptoKeyVersions.
Args:
@@ -603,6 +700,10 @@
more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).
+ 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).
pageToken: string, Optional. Optional pagination token, returned earlier via
ListCryptoKeyVersionsResponse.next_page_token.
pageSize: integer, Optional. Optional limit on the number of CryptoKeyVersions to
@@ -611,10 +712,6 @@
ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.
If unspecified, the server will pick an appropriate default.
view: string, The fields to include in the response.
- 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -624,11 +721,6 @@
An object of the form:
{ # Response message for KeyManagementService.ListCryptoKeyVersions.
- "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.
- "totalSize": 42, # The total number of CryptoKeyVersions that matched the
- # query.
"cryptoKeyVersions": [ # The list of CryptoKeyVersions.
{ # A CryptoKeyVersion represents an individual cryptographic key, and the
# associated key material.
@@ -640,33 +732,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -677,12 +752,34 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
},
],
+ "totalSize": 42, # The total number of CryptoKeyVersions that matched the
+ # query.
+ "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.
}</pre>
</div>
@@ -726,33 +823,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -763,10 +843,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}
updateMask: string, Required. List of fields to be updated in this request.
@@ -788,33 +885,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -825,10 +905,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}</pre>
</div>
@@ -868,33 +965,16 @@
# 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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
- # CryptoKeyVersion. Only present if the underlying key material was
- # imported.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- # configuring a CryptoKeyVersion that are specific to the
- # EXTERNAL protection level.
- "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
- },
- "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # destroyed. Only present if state is
- # DESTROYED.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
- # for destruction. Only present if state is
- # DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"state": "A String", # The current state of the CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"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
# 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
@@ -905,10 +985,27 @@
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
},
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
- # generated.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ # for destruction. Only present if state is
+ # DESTROY_SCHEDULED.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
+ "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ # configuring a CryptoKeyVersion that are specific to the
+ # EXTERNAL protection level.
+ "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
+ },
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ # CryptoKeyVersion. Only present if the underlying key material was
+ # imported.
+ "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
+ # CryptoKeyVersion supports.
}</pre>
</div>