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

Class CreateKeyOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.ibm_key_protect_api.v2.model.CreateKeyOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateKeyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createKey options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateKeyOptions.Builder	Builder.
static interface	CreateKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.

Method Summary

Modifier and Type	Method	Description
String	bluemixInstance()	Gets the bluemixInstance.
String	correlationId()	Gets the correlationId.
InputStream	keyCreateBody()	Gets the keyCreateBody.
CreateKeyOptions.Builder	newBuilder()	New builder.
String	prefer()	Gets the prefer.
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 CreateKeyOptions.Builder newBuilder()

New builder.

Returns:

a CreateKeyOptions builder

bluemixInstance

public String bluemixInstance()

Gets the bluemixInstance. The IBM Cloud instance ID that identifies your Key Protect service instance.

Returns:

the bluemixInstance

keyCreateBody

public InputStream keyCreateBody()

Gets the keyCreateBody. The base request for creating a new key.

Returns:

the keyCreateBody

correlationId

public String correlationId()

Gets the correlationId. The v4 UUID used to correlate and track transactions.

Returns:

the correlationId

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

xKmsKeyRing

public String xKmsKeyRing()

Gets the xKmsKeyRing. The ID of the key ring that the specified key belongs to. 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