com.fortanix.sdkms.v1.model

Class PersistTransientKeyRequest

java.lang.Object

com.fortanix.sdkms.v1.model.PersistTransientKeyRequest

public class PersistTransientKeyRequest
extends Object

PersistTransientKeyRequest

Constructor Summary

Constructors

Constructor and Description
PersistTransientKeyRequest()

Method Summary

Modifier and Type	Method and Description
PersistTransientKeyRequest	addKeyOpsItem(KeyOperations keyOpsItem)
PersistTransientKeyRequest	customMetadata(Map<String,String> customMetadata)
PersistTransientKeyRequest	description(String description)
PersistTransientKeyRequest	enabled(Boolean enabled)
boolean	equals(Object o)
Map<String,String>	getCustomMetadata() User-defined metadata for the persisted key.
String	getDescription() Description of the persisted security object.
Boolean	getEnabled() Whether the new security object should be enabled.
String	getGroupId() Group ID (not name) of the security group that the persisted security object should belong to.
List<KeyOperations>	getKeyOps() Optional array of key operations to be enabled for this security object.
String	getName() Name of the persisted security object.
String	getTransientKey() Transient key blob.
PersistTransientKeyRequest	groupId(String groupId)
int	hashCode()
PersistTransientKeyRequest	keyOps(List<KeyOperations> keyOps)
PersistTransientKeyRequest	name(String name)
PersistTransientKeyRequest	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	setName(String name)
void	setTransientKey(String transientKey)
String	toString()
PersistTransientKeyRequest	transientKey(String transientKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistTransientKeyRequest

public PersistTransientKeyRequest()

Method Detail

name

public PersistTransientKeyRequest name(String name)

getName

public String getName()

Name of the persisted security object. Security object names must be unique within an account.

Returns:

name

setName

public void setName(String name)

description

public PersistTransientKeyRequest description(String description)

getDescription

public String getDescription()

Description of the persisted security object.

Returns:

description

setDescription

public void setDescription(String description)

customMetadata

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

putCustomMetadataItem

public PersistTransientKeyRequest putCustomMetadataItem(String key,
                                                        String customMetadataItem)

getCustomMetadata

public Map<String,String> getCustomMetadata()

User-defined metadata for the persisted key. Stored as key-value pairs.

Returns:

customMetadata

setCustomMetadata

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

enabled

public PersistTransientKeyRequest enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Whether the new security object should be enabled. Disabled security objects may not perform cryptographic operations.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

keyOps

public PersistTransientKeyRequest keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

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

groupId

public PersistTransientKeyRequest groupId(String groupId)

getGroupId

public String getGroupId()

Group ID (not name) of the security group that the persisted 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)

transientKey

public PersistTransientKeyRequest transientKey(String transientKey)

getTransientKey

public String getTransientKey()

Transient key blob.

Returns:

transientKey

setTransientKey

public void setTransientKey(String transientKey)

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