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

Class CreateKeyAliasOptions

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.CreateKeyAliasOptions

All Implemented Interfaces:

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

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

The createKeyAlias options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateKeyAliasOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	alias()	Gets the alias.
String	bluemixInstance()	Gets the bluemixInstance.
String	correlationId()	Gets the correlationId.
String	id()	Gets the id.
CreateKeyAliasOptions.Builder	newBuilder()	New builder.
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 CreateKeyAliasOptions.Builder newBuilder()

New builder.

Returns:

a CreateKeyAliasOptions builder

id

public String id()

Gets the id. The v4 UUID or alias that uniquely identifies the key.

Returns:

the id

alias

public String alias()

Gets the alias. A human-readable alias that uniquely identifies a key. Each alias is unique only within the given instance and is not reserved across the Key Protect service. Each key can have up to five aliases. There is no limit to the number of aliases per instance. The length of the alias can be between 2 - 90 characters, inclusive. An alias must be alphanumeric and cannot contain spaces or special characters other than '-' or '_'. Also, the alias cannot be a version 4 UUID and must not be a Key Protect reserved name: `allowed_ip`, `key`, `keys`, `metadata`, `policy`, `policies`, `registration`, `registrations`, `ring`, `rings`, `rotate`, `wrap`, `unwrap`, `rewrap`, `version`, `versions`.

Returns:

the alias

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