build: run docs regen in synth.py (#1059)
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 5344fe7..a05e15e 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
@@ -99,7 +99,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 wrapped key material provided in the request. The version ID will be assigned the next sequential id within the CryptoKey.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, filter=None, view=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, filter=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>
@@ -134,8 +134,8 @@
An object of the form:
{ # Response message for KeyManagementService.AsymmetricDecrypt.
- "plaintext": "A String", # The decrypted data originally encrypted with the matching public key.
"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.
+ "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.
}</pre>
</div>
@@ -152,9 +152,9 @@
{ # Request message for KeyManagementService.AsymmetricSign.
"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.
"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.
- "sha384": "A String", # A message digest produced with the SHA-384 algorithm.
- "sha512": "A String", # A message digest produced with the SHA-512 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.
+ "sha384": "A String", # A message digest produced with the SHA-384 algorithm.
},
}
@@ -168,9 +168,9 @@
{ # Response message for KeyManagementService.AsymmetricSign.
"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.
- "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.
"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.
"signature": "A String", # The created signature.
+ "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.
}</pre>
</div>
@@ -189,35 +189,35 @@
The object takes the form of:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}
x__xgafv: string, V1 error format.
@@ -229,35 +229,35 @@
An object of the form:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -282,35 +282,35 @@
An object of the form:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -329,35 +329,35 @@
An object of the form:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -377,9 +377,9 @@
{ # The public key for a given CryptoKeyVersion. Obtained via GetPublicKey.
"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).
+ "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.
"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.
}</pre>
</div>
@@ -407,52 +407,52 @@
An object of the form:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, filter=None, view=None, orderBy=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, filter=None, view=None, x__xgafv=None)</code>
<pre>Lists CryptoKeyVersions.
Args:
parent: string, Required. The resource name of the CryptoKey to list, in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. (required)
+ 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).
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.
+ pageToken: string, Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.
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).
view: string, The fields to include in the response.
Allowed values
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED - Default view for each CryptoKeyVersion. Does not include the attestation field.
FULL - Provides all fields in each CryptoKeyVersion, including the attestation.
- 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -462,41 +462,41 @@
An object of the form:
{ # Response message for KeyManagementService.ListCryptoKeyVersions.
+ "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. 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
],
"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.
}</pre>
</div>
@@ -524,35 +524,35 @@
The object takes the form of:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}
updateMask: string, Required. List of fields to be updated in this request.
@@ -565,35 +565,35 @@
An object of the form:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -618,35 +618,35 @@
An object of the form:
{ # 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.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+ "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
"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.
"format": "A String", # Output only. The format of the attestation data.
- "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
"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
- "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
- "A String",
- ],
"caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
"A String",
],
"googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
"A String",
],
+ "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+ "A String",
+ ],
},
+ "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
- "importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+ "state": "A String", # The current state of the CryptoKeyVersion.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
- "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was imported.
"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.
"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.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+ "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.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>