PutPolicyOptions (IBM Cloud Key Protect Java SDK 1.0.3 API)

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PutPolicyOptions.Builder`	Builder.
`static interface`	`PutPolicyOptions.Policy`	The type of policy that is associated with the specified key.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bluemixInstance()`	Gets the bluemixInstance.
`String`	`correlationId()`	Gets the correlationId.
`String`	`id()`	Gets the id.
`SetKeyPoliciesOneOf`	`keyPolicyPutBody()`	Gets the keyPolicyPutBody.
`PutPolicyOptions.Builder`	`newBuilder()`	New builder.
`String`	`policy()`	Gets the policy.
`String`	`xKmsKeyRing()`	Gets the xKmsKeyRing.

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 PutPolicyOptions.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a PutPolicyOptions builder
  - id
```
public String id()
```
    Gets the id. The v4 UUID or alias 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
  - keyPolicyPutBody
```
public SetKeyPoliciesOneOf keyPolicyPutBody()
```
    Gets the keyPolicyPutBody. The base request for key policy create or update.
    
    Returns:
    
    the keyPolicyPutBody
  - 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
  - policy
```
public String policy()
```
    Gets the policy. The type of policy that is associated with the specified key.
    
    Returns:
    
    the policy