Package com.ibm.cloud.ibm_key_protect_api.v2.model

Class DeleteKeyOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class DeleteKeyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The deleteKey options.

    • Method Detail

      • id

        public String id()
        Gets the id. The v4 UUID that uniquely identifies the key.
        Returns:
        the id

      • bluemixInstance

        public String bluemixInstance()
        Gets the bluemixInstance. The IBM Cloud instance ID that identifies your Key Protect service instance.
        Returns:
        the bluemixInstance

      • correlationId

        public String correlationId()
        Gets the correlationId. The v4 UUID used to correlate and track transactions.
        Returns:
        the correlationId

      • xKmsKeyRing

        public String xKmsKeyRing()
        Gets the xKmsKeyRing. The ID of the key ring that the specified key is a part of. When the header is not specified, Key Protect will perform a key ring lookup. For a more optimized request, specify the key ring on every call. The key ring ID of keys that are created without an `X-Kms-Key-Ring` header is: `default`.
        Returns:
        the xKmsKeyRing

      • prefer

        public String prefer()
        Gets the prefer. Alters server behavior for POST or DELETE operations. A header with `return=minimal` causes the service to return only the key identifier as metadata. A header containing `return=representation` returns both the key material and metadata in the response entity-body. If the key has been designated as a root key, the system cannot return the key material. **Note:** During POST operations, Key Protect may not immediately return the key material due to key generation time. To retrieve the key material, you can perform a subsequent `GET /keys/{id}` request.
        Returns:
        the prefer

      • force

        public Boolean force()
        Gets the force. If set to `true`, Key Protect forces deletion on a key that is protecting a cloud resource, such as a Cloud Object Storage bucket. The action removes any registrations that are associated with the key. **Note:** If a key is protecting a cloud resource that has a retention policy, Key Protect cannot delete the key. Use `GET keys/{id}/registrations` to review registrations between the key and its associated cloud resources. To enable deletion, contact an account owner to remove the retention policy on each resource that is associated with this key.
        Returns:
        the force