docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
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 ed628d9..932b349 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, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None, view=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, orderBy=None, filter=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,7 +121,7 @@
The object takes the form of:
{ # Request message for KeyManagementService.AsymmetricDecrypt.
- "ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public
+ "ciphertext": "A String", # Required. The data encrypted with the named CryptoKeyVersion's public
# key using OAEP.
}
@@ -134,7 +134,7 @@
An object of the form:
{ # Response message for KeyManagementService.AsymmetricDecrypt.
- "plaintext": "A String", # The decrypted data originally encrypted with the matching public key.
+ "plaintext": "A String", # The decrypted data originally encrypted with the matching public key.
}</pre>
</div>
@@ -150,12 +150,12 @@
The object takes the form of:
{ # Request message for KeyManagementService.AsymmetricSign.
- "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
+ "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.
- "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.
+ "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.
},
}
@@ -168,7 +168,7 @@
An object of the form:
{ # Response message for KeyManagementService.AsymmetricSign.
- "signature": "A String", # The created signature.
+ "signature": "A String", # The created signature.
}</pre>
</div>
@@ -196,47 +196,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -257,47 +257,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}</pre>
</div>
@@ -342,47 +342,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}</pre>
</div>
@@ -410,47 +410,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}</pre>
</div>
@@ -474,13 +474,13 @@
{ # 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
+ "algorithm": "A String", # The Algorithm associated
+ # with this key.
+ "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).
- "algorithm": "A String", # The Algorithm associated
- # with this key.
}</pre>
</div>
@@ -499,13 +499,11 @@
The object takes the form of:
{ # Request message for KeyManagementService.ImportCryptoKeyVersion.
- "importJob": "A String", # Required. The name of the ImportJob that was used to
- # wrap this key material.
- "algorithm": "A String", # Required. The algorithm of
+ "algorithm": "A String", # Required. The algorithm of
# the key being imported. This does not need to match the
# version_template of the CryptoKey this
# version imports into.
- "rsaAesWrappedKey": "A String", # Wrapped key material produced with
+ "rsaAesWrappedKey": "A String", # Wrapped key material produced with
# RSA_OAEP_3072_SHA1_AES_256
# or
# RSA_OAEP_4096_SHA1_AES_256.
@@ -528,6 +526,8 @@
#
# This format is the same as the format produced by PKCS#11 mechanism
# CKM_RSA_AES_KEY_WRAP.
+ "importJob": "A String", # Required. The name of the ImportJob that was used to
+ # wrap this key material.
}
x__xgafv: string, V1 error format.
@@ -548,88 +548,83 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None, view=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, orderBy=None, filter=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).
+ pageToken: string, Optional. Optional pagination token, returned earlier via
+ListCryptoKeyVersionsResponse.next_page_token.
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.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ 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).
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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
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.
+ "cryptoKeyVersions": [ # The list of CryptoKeyVersions.
{ # A CryptoKeyVersion represents an individual cryptographic key, and the
# associated key material.
#
@@ -640,49 +635,54 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
},
],
+ "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>
@@ -695,14 +695,14 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Update a CryptoKeyVersion's metadata.
+ <pre>Update a CryptoKeyVersion's metadata.
state may be changed between
ENABLED and
@@ -726,47 +726,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}
updateMask: string, Required. List of fields to be updated in this request.
@@ -788,47 +788,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}</pre>
</div>
@@ -868,47 +868,47 @@
# 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.
- "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
+ "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
+ # was imported.
+ "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # destroyed. Only present if state is
+ # DESTROYED.
+ "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
+ "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/*`.
- "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
- # performed with this CryptoKeyVersion.
- "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
+ "state": "A String", # The current state of the CryptoKeyVersion.
+ "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
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
- "content": "A String", # Output only. The attestation data provided by the HSM when the key
+ "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.
- "format": "A String", # Output only. The format of the attestation data.
},
- "state": "A String", # The current state of the CryptoKeyVersion.
- "importJob": "A String", # Output only. The name of the ImportJob used to import this
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+ "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
+ # generated.
+ "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
+ # performed with this CryptoKeyVersion.
+ "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.
- "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.
- "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
- # CryptoKeyVersion supports.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
+ "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.
+ "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.
}</pre>
</div>