com.fortanix.sdkms.v1.model

Class DeriveKeyRequestEx

java.lang.Object

com.fortanix.sdkms.v1.model.DeriveKeyRequestEx

public class DeriveKeyRequestEx
extends Object

DeriveKeyRequestEx

Constructor Summary

Constructors

Constructor and Description
DeriveKeyRequestEx()

Method Summary

Modifier and Type	Method and Description
DeriveKeyRequestEx	_transient(Boolean _transient)
DeriveKeyRequestEx	addKeyOpsItem(KeyOperations keyOpsItem)
DeriveKeyRequestEx	customMetadata(Map<String,String> customMetadata)
DeriveKeyRequestEx	description(String description)
DeriveKeyRequestEx	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.
SobjectDescriptor	getKey() Get key
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.
Boolean	getTransient() If this is true, DSM will derive a transient key.
DeriveKeyRequestEx	groupId(String groupId)
int	hashCode()
DeriveKeyRequestEx	key(SobjectDescriptor key)
DeriveKeyRequestEx	keyOps(List<KeyOperations> keyOps)
DeriveKeyRequestEx	keySize(Integer keySize)
DeriveKeyRequestEx	keyType(ObjectType keyType)
DeriveKeyRequestEx	mechanism(DeriveKeyMechanism mechanism)
DeriveKeyRequestEx	name(String name)
DeriveKeyRequestEx	putCustomMetadataItem(String key, String customMetadataItem)
void	setCustomMetadata(Map<String,String> customMetadata)
void	setDescription(String description)
void	setEnabled(Boolean enabled)
void	setGroupId(String groupId)
void	setKey(SobjectDescriptor key)
void	setKeyOps(List<KeyOperations> keyOps)
void	setKeySize(Integer keySize)
void	setKeyType(ObjectType keyType)
void	setMechanism(DeriveKeyMechanism mechanism)
void	setName(String name)
void	setTransient(Boolean _transient)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeriveKeyRequestEx

public DeriveKeyRequestEx()

Method Detail

key

public DeriveKeyRequestEx key(SobjectDescriptor key)

getKey

public SobjectDescriptor getKey()

Get key

Returns:

key

setKey

public void setKey(SobjectDescriptor key)

name

public DeriveKeyRequestEx 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 DeriveKeyRequestEx 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 DeriveKeyRequestEx 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 DeriveKeyRequestEx keyType(ObjectType keyType)

getKeyType

public ObjectType getKeyType()

Get keyType

Returns:

keyType

setKeyType

public void setKeyType(ObjectType keyType)

mechanism

public DeriveKeyRequestEx mechanism(DeriveKeyMechanism mechanism)

getMechanism

public DeriveKeyMechanism getMechanism()

Get mechanism

Returns:

mechanism

setMechanism

public void setMechanism(DeriveKeyMechanism mechanism)

enabled

public DeriveKeyRequestEx 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 DeriveKeyRequestEx description(String description)

getDescription

public String getDescription()

Description for the new key.

Returns:

description

setDescription

public void setDescription(String description)

keyOps

public DeriveKeyRequestEx keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

public DeriveKeyRequestEx 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 DeriveKeyRequestEx customMetadata(Map<String,String> customMetadata)

putCustomMetadataItem

public DeriveKeyRequestEx 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)

_transient

public DeriveKeyRequestEx _transient(Boolean _transient)

getTransient

public Boolean getTransient()

If this is true, DSM will derive a transient key.

Returns:

_transient

setTransient

public void setTransient(Boolean _transient)

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