DeleteKeyRingOptions (IBM Cloud Key Protect Java SDK 1.0.2 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.model.GenericModel
- - com.ibm.cloud.ibm_key_protect_api.v2.model.DeleteKeyRingOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel
```
public class DeleteKeyRingOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
```
The deleteKeyRing options.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DeleteKeyRingOptions.Builder
Builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bluemixInstance()`	Gets the bluemixInstance.
`String`	`correlationId()`	Gets the correlationId.
`Boolean`	`force()`	Gets the force.
`String`	`keyRingId()`	Gets the keyRingId.
`DeleteKeyRingOptions.Builder`	`newBuilder()`	New builder.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel
equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newBuilder
```
public DeleteKeyRingOptions.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a DeleteKeyRingOptions builder
  - keyRingId
```
public String keyRingId()
```
    Gets the keyRingId. The ID that identifies the key ring. Each ID is unique only within the given instance and is not reserved across the Key Protect service.
    
    Returns:
    
    the keyRingId
  - 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
  - force
```
public Boolean force()
```
    Gets the force. Force delete the key ring. All keys in the key ring are required to be deleted (in state `5`) before this action can be performed. If the key ring to be deleted contains keys, they will be moved to the `default` key ring which requires the `kms.secrets.patch` IAM action.
    
    Returns:
    
    the force