com.ibm.cloud.ibm_key_protect_api.v2.model

Class CreateKMIPAdapterRequestBodyResources

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.CreateKMIPAdapterRequestBodyResources

All Implemented Interfaces:

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

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

CreateKMIPAdapterRequestBodyResources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateKMIPAdapterRequestBodyResources.Builder Builder.
static interface	CreateKMIPAdapterRequestBodyResources.Profile The profile of KMIP adapter to be created.

Method Summary

Modifier and Type	Method and Description
String	description() Gets the description.
String	name() Gets the name.
CreateKMIPAdapterRequestBodyResources.Builder	newBuilder() New builder.
String	profile() Gets the profile.
KMIPProfileDataBody	profileData() Gets the profileData.

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

New builder.

Returns:

a CreateKMIPAdapterRequestBodyResources builder

name

public String name()

Gets the name. A human-readable name of the KMIP adapter unique within the kms instance. If one is not specified, one will be autogenerated of the format `kmip_adapter_<random_string>`. To protect your privacy do not use personal data, such as your name or location, as a name for your KMIP adapter. The name must be alphanumeric and cannot contain spaces or special characters other than `-` or `_`. The name cannot be a UUID.

Returns:

the name

description

public String description()

Gets the description. The optional description of the KMIP adapter. The maximum length is 240 characters. To protect your privacy, do not use personal data, such as your name or location, as a description for your KMIP adapter.

Returns:

the description

profile

public String profile()

Gets the profile. The profile of KMIP adapter to be created.

Returns:

the profile

profileData

public KMIPProfileDataBody profileData()

Gets the profileData. The data specific to the KMIP Adapter profile. This is a required field for profile `native_1.0`.

Returns:

the profileData