com.fortanix.sdkms.v1.model

Class DeriveKeyRequest

java.lang.Object

com.fortanix.sdkms.v1.model.DeriveKeyRequest

public class DeriveKeyRequest
extends Object

DeriveKeyRequest

Constructor Summary

Constructors

Constructor and Description
DeriveKeyRequest()

Method Summary

Modifier and Type	Method and Description
DeriveKeyRequest	addKeyOpsItem(KeyOperations keyOpsItem)
DeriveKeyRequest	customMetadata(Map<String,String> customMetadata)
DeriveKeyRequest	description(String description)
DeriveKeyRequest	enabled(Boolean enabled)
boolean	equals(Object o)
Map<String,String>	getCustomMetadata() User-defined metadata for this key.
String	getDescription() Description for the new key.
Boolean	getEnabled() Whether the derived key should have cryptographic operations enabled.
String	getGroupId() Group ID (not name) of the security group that this security object should belong to.
List<KeyOperations>	getKeyOps() Optional array of key operations to be enabled for this security object.
Integer	getKeySize() Key size of the derived key in bits (not bytes).
ObjectType	getKeyType() Get keyType
DeriveKeyMechanism	getMechanism() Get mechanism
String	getName() Name of the derived key.
DeriveKeyRequest	groupId(String groupId)
int	hashCode()
DeriveKeyRequest	keyOps(List<KeyOperations> keyOps)
DeriveKeyRequest	keySize(Integer keySize)
DeriveKeyRequest	keyType(ObjectType keyType)
DeriveKeyRequest	mechanism(DeriveKeyMechanism mechanism)
DeriveKeyRequest	name(String name)
DeriveKeyRequest	putCustomMetadataItem(String key, String customMetadataItem)
void	setCustomMetadata(Map<String,String> customMetadata)
void	setDescription(String description)
void	setEnabled(Boolean enabled)
void	setGroupId(String groupId)
void	setKeyOps(List<KeyOperations> keyOps)
void	setKeySize(Integer keySize)
void	setKeyType(ObjectType keyType)
void	setMechanism(DeriveKeyMechanism mechanism)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeriveKeyRequest

public DeriveKeyRequest()

Method Detail

name

public DeriveKeyRequest name(String name)

getName

public String getName()

Name of the derived key. Key names must be unique within an account.

Returns:

name

setName

public void setName(String name)

groupId

public DeriveKeyRequest groupId(String groupId)

getGroupId

public String getGroupId()

Group ID (not name) of the security group that this security object should belong to. The user or application creating this security object must be a member of this group. If no group is specified, the default group for the user or application will be used.

Returns:

groupId

setGroupId

public void setGroupId(String groupId)

keySize

public DeriveKeyRequest keySize(Integer keySize)

getKeySize

public Integer getKeySize()

Key size of the derived key in bits (not bytes).

Returns:

keySize

setKeySize

public void setKeySize(Integer keySize)

keyType

public DeriveKeyRequest keyType(ObjectType keyType)

getKeyType

public ObjectType getKeyType()

Get keyType

Returns:

keyType

setKeyType

public void setKeyType(ObjectType keyType)

mechanism

public DeriveKeyRequest mechanism(DeriveKeyMechanism mechanism)

getMechanism

public DeriveKeyMechanism getMechanism()

Get mechanism

Returns:

mechanism

setMechanism

public void setMechanism(DeriveKeyMechanism mechanism)

enabled

public DeriveKeyRequest enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Whether the derived key should have cryptographic operations enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

description

public DeriveKeyRequest description(String description)

getDescription

public String getDescription()

Description for the new key.

Returns:

description

setDescription

public void setDescription(String description)

keyOps

public DeriveKeyRequest keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

public DeriveKeyRequest addKeyOpsItem(KeyOperations keyOpsItem)

getKeyOps

public List<KeyOperations> getKeyOps()

Optional array of key operations to be enabled for this security object. If this property is not provided, the DSM server will provide a default set of key operations. Note that if you provide an empty array, all key operations will be disabled.

Returns:

keyOps

setKeyOps

public void setKeyOps(List<KeyOperations> keyOps)

customMetadata

public DeriveKeyRequest customMetadata(Map<String,String> customMetadata)

putCustomMetadataItem

public DeriveKeyRequest putCustomMetadataItem(String key,
                                              String customMetadataItem)

getCustomMetadata

public Map<String,String> getCustomMetadata()

User-defined metadata for this key. Stored as key-value pairs.

Returns:

customMetadata

setCustomMetadata

public void setCustomMetadata(Map<String,String> customMetadata)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object