com.ibm.cloud.ibm_key_protect_api.v2.model

Class ModifiableRegistrationResourceBody

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.ModifiableRegistrationResourceBody

All Implemented Interfaces:

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

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

The base schema for the resource in the body of a create registration.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	description() Gets the description.
String	keyVersionId() Gets the keyVersionId.
ModifiableRegistrationResourceBody.Builder	newBuilder() New builder.
Boolean	preventKeyDeletion() Gets the preventKeyDeletion.
String	registrationMetadata() Gets the registrationMetadata.

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 ModifiableRegistrationResourceBody.Builder newBuilder()

New builder.

Returns:

a ModifiableRegistrationResourceBody builder

preventKeyDeletion

public Boolean preventKeyDeletion()

Gets the preventKeyDeletion. A boolean that determines whether Key Protect must prevent deletion of a root key. If set to `true`, Key Protect prevents deletion of the specified root key and its associated protected resources. The system prevents the deletion of any key that has at least one registration where `preventKeyDeletion` is `true`.

Returns:

the preventKeyDeletion

description

public String description()

Gets the description. A text field that cloud services can use to store external metadata about the registration. This field is exposed to customers when they review registered resources using GET /registrations.

Returns:

the description

registrationMetadata

public String registrationMetadata()

Gets the registrationMetadata. A text field that cloud services can use to store internal metadata about the registration. This field is not exposed to customers and is visible only with IBM Cloud service to service calls.

Returns:

the registrationMetadata

keyVersionId

public String keyVersionId()

Gets the keyVersionId. The ID of the key version that you want to register. This must be a version that is newer than the registered key version.

Returns:

the keyVersionId