Interface DeleteKeyRequest.Builder

    • Method Detail

      • keyName

        DeleteKeyRequest.Builder keyName​(String keyName)

        The name of the API key to delete.

        Parameters:
        keyName - The name of the API key to delete.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • forceDelete

        DeleteKeyRequest.Builder forceDelete​(Boolean forceDelete)

        ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

        Valid values: true, or false.

        Required: No

        This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

        Parameters:
        forceDelete - ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

        Valid values: true, or false.

        Required: No

        This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

        Returns:
        Returns a reference to this object so that method calls can be chained together.