io.peacemakr.crypto.swagger.client.model

Class SymmetricKeyUseDomain

java.lang.Object

io.peacemakr.crypto.swagger.client.model.SymmetricKeyUseDomain

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2020-02-29T21:54:50.815Z")
public class SymmetricKeyUseDomain
extends java.lang.Object

SymmetricKeyUseDomain

Constructor Summary

Constructors

Constructor and Description
SymmetricKeyUseDomain()

Method Summary

Methods

Modifier and Type	Method and Description
SymmetricKeyUseDomain	addEncryptionKeyIdsItem(java.lang.String encryptionKeyIdsItem)
SymmetricKeyUseDomain	creationTime(java.lang.Integer creationTime)
SymmetricKeyUseDomain	digestAlgorithm(java.lang.String digestAlgorithm)
SymmetricKeyUseDomain	encryptingPackagedCiphertextVersion(java.lang.Integer encryptingPackagedCiphertextVersion)
SymmetricKeyUseDomain	encryptionKeyIds(java.util.List<java.lang.String> encryptionKeyIds)
SymmetricKeyUseDomain	endableKDSFallbackToCloud(java.lang.Boolean endableKDSFallbackToCloud)
boolean	equals(java.lang.Object o)
java.lang.Integer	getCreationTime() Get creationTime
java.lang.String	getDigestAlgorithm() The digest algorithm to use for signing messages in this use domain
java.lang.Integer	getEncryptingPackagedCiphertextVersion() after encrypting new plaintexts, package the ciphertext with this version of the packaged ciphertext
java.util.List<java.lang.String>	getEncryptionKeyIds() these are the semmetric key id's that belong to this use domain - these keys never belong to any other use domain
java.lang.String	getId() Get id
java.lang.String	getName() Get name
java.lang.String	getOwnerOrgId() the org id of the organization that owns these symmetric keys
java.lang.Integer	getSymmetricKeyDecryptionUseTTL() number of seconds since key creation that the key will be available for decryption
java.lang.String	getSymmetricKeyDerivationServiceId() the symmetric key derivation serivce id that can derive and wrap these keys
java.lang.String	getSymmetricKeyEncryptionAlg() the specific encryption alg to encrypt new plaintexts for application layer encryption operations
java.lang.Integer	getSymmetricKeyEncryptionUseTTL() number of seconds since key creation that the key will be available for encryption
java.lang.Integer	getSymmetricKeyInceptionTTL() number of seconds since key creation that the key will be available for encryption
java.lang.Integer	getSymmetricKeyLength() the number of bits of all symmetric keys in this use domain
java.lang.Integer	getSymmetricKeyRetentionUseTTL() number of seconds since key creation that the key will be available for retention purposes
int	hashCode()
SymmetricKeyUseDomain	id(java.lang.String id)
java.lang.Boolean	isEndableKDSFallbackToCloud() if all registered kds service become unreachable, then incoming requests for new and existing keys may fallback to the cloud provided KDS
java.lang.Boolean	isRequireSignedKeyDelivery() if required, all clients must receive these keys in a signed symmetric key delivery from the key deriver
java.lang.Boolean	isSymmetricKeyDecryptionAllowed() whether this use domain is available for decryption; if false, these keys should not be used for decrypting messages
java.lang.Boolean	isSymmetricKeyEncryptionAllowed() whether this use domain is available for encryption; if false, these keys should not be used for encrypting new messages
SymmetricKeyUseDomain	name(java.lang.String name)
SymmetricKeyUseDomain	ownerOrgId(java.lang.String ownerOrgId)
SymmetricKeyUseDomain	requireSignedKeyDelivery(java.lang.Boolean requireSignedKeyDelivery)
void	setCreationTime(java.lang.Integer creationTime)
void	setDigestAlgorithm(java.lang.String digestAlgorithm)
void	setEncryptingPackagedCiphertextVersion(java.lang.Integer encryptingPackagedCiphertextVersion)
void	setEncryptionKeyIds(java.util.List<java.lang.String> encryptionKeyIds)
void	setEndableKDSFallbackToCloud(java.lang.Boolean endableKDSFallbackToCloud)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
void	setOwnerOrgId(java.lang.String ownerOrgId)
void	setRequireSignedKeyDelivery(java.lang.Boolean requireSignedKeyDelivery)
void	setSymmetricKeyDecryptionAllowed(java.lang.Boolean symmetricKeyDecryptionAllowed)
void	setSymmetricKeyDecryptionUseTTL(java.lang.Integer symmetricKeyDecryptionUseTTL)
void	setSymmetricKeyDerivationServiceId(java.lang.String symmetricKeyDerivationServiceId)
void	setSymmetricKeyEncryptionAlg(java.lang.String symmetricKeyEncryptionAlg)
void	setSymmetricKeyEncryptionAllowed(java.lang.Boolean symmetricKeyEncryptionAllowed)
void	setSymmetricKeyEncryptionUseTTL(java.lang.Integer symmetricKeyEncryptionUseTTL)
void	setSymmetricKeyInceptionTTL(java.lang.Integer symmetricKeyInceptionTTL)
void	setSymmetricKeyLength(java.lang.Integer symmetricKeyLength)
void	setSymmetricKeyRetentionUseTTL(java.lang.Integer symmetricKeyRetentionUseTTL)
SymmetricKeyUseDomain	symmetricKeyDecryptionAllowed(java.lang.Boolean symmetricKeyDecryptionAllowed)
SymmetricKeyUseDomain	symmetricKeyDecryptionUseTTL(java.lang.Integer symmetricKeyDecryptionUseTTL)
SymmetricKeyUseDomain	symmetricKeyDerivationServiceId(java.lang.String symmetricKeyDerivationServiceId)
SymmetricKeyUseDomain	symmetricKeyEncryptionAlg(java.lang.String symmetricKeyEncryptionAlg)
SymmetricKeyUseDomain	symmetricKeyEncryptionAllowed(java.lang.Boolean symmetricKeyEncryptionAllowed)
SymmetricKeyUseDomain	symmetricKeyEncryptionUseTTL(java.lang.Integer symmetricKeyEncryptionUseTTL)
SymmetricKeyUseDomain	symmetricKeyInceptionTTL(java.lang.Integer symmetricKeyInceptionTTL)
SymmetricKeyUseDomain	symmetricKeyLength(java.lang.Integer symmetricKeyLength)
SymmetricKeyUseDomain	symmetricKeyRetentionUseTTL(java.lang.Integer symmetricKeyRetentionUseTTL)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SymmetricKeyUseDomain

public SymmetricKeyUseDomain()

Method Detail

id

public SymmetricKeyUseDomain id(java.lang.String id)

getId

public java.lang.String getId()

Get id

Returns:

id

setId

public void setId(java.lang.String id)

ownerOrgId

public SymmetricKeyUseDomain ownerOrgId(java.lang.String ownerOrgId)

getOwnerOrgId

public java.lang.String getOwnerOrgId()

the org id of the organization that owns these symmetric keys

Returns:

ownerOrgId

setOwnerOrgId

public void setOwnerOrgId(java.lang.String ownerOrgId)

name

public SymmetricKeyUseDomain name(java.lang.String name)

getName

public java.lang.String getName()

Get name

Returns:

name

setName

public void setName(java.lang.String name)

creationTime

public SymmetricKeyUseDomain creationTime(java.lang.Integer creationTime)

getCreationTime

public java.lang.Integer getCreationTime()

Get creationTime

Returns:

creationTime

setCreationTime

public void setCreationTime(java.lang.Integer creationTime)

symmetricKeyInceptionTTL

public SymmetricKeyUseDomain symmetricKeyInceptionTTL(java.lang.Integer symmetricKeyInceptionTTL)

getSymmetricKeyInceptionTTL

public java.lang.Integer getSymmetricKeyInceptionTTL()

number of seconds since key creation that the key will be available for encryption

Returns:

symmetricKeyInceptionTTL

setSymmetricKeyInceptionTTL

public void setSymmetricKeyInceptionTTL(java.lang.Integer symmetricKeyInceptionTTL)

symmetricKeyEncryptionUseTTL

public SymmetricKeyUseDomain symmetricKeyEncryptionUseTTL(java.lang.Integer symmetricKeyEncryptionUseTTL)

getSymmetricKeyEncryptionUseTTL

public java.lang.Integer getSymmetricKeyEncryptionUseTTL()

number of seconds since key creation that the key will be available for encryption

Returns:

symmetricKeyEncryptionUseTTL

setSymmetricKeyEncryptionUseTTL

public void setSymmetricKeyEncryptionUseTTL(java.lang.Integer symmetricKeyEncryptionUseTTL)

symmetricKeyEncryptionAllowed

public SymmetricKeyUseDomain symmetricKeyEncryptionAllowed(java.lang.Boolean symmetricKeyEncryptionAllowed)

isSymmetricKeyEncryptionAllowed

public java.lang.Boolean isSymmetricKeyEncryptionAllowed()

whether this use domain is available for encryption; if false, these keys should not be used for encrypting new messages

Returns:

symmetricKeyEncryptionAllowed

setSymmetricKeyEncryptionAllowed

public void setSymmetricKeyEncryptionAllowed(java.lang.Boolean symmetricKeyEncryptionAllowed)

symmetricKeyDecryptionUseTTL

public SymmetricKeyUseDomain symmetricKeyDecryptionUseTTL(java.lang.Integer symmetricKeyDecryptionUseTTL)

getSymmetricKeyDecryptionUseTTL

public java.lang.Integer getSymmetricKeyDecryptionUseTTL()

number of seconds since key creation that the key will be available for decryption

Returns:

symmetricKeyDecryptionUseTTL

setSymmetricKeyDecryptionUseTTL

public void setSymmetricKeyDecryptionUseTTL(java.lang.Integer symmetricKeyDecryptionUseTTL)

symmetricKeyDecryptionAllowed

public SymmetricKeyUseDomain symmetricKeyDecryptionAllowed(java.lang.Boolean symmetricKeyDecryptionAllowed)

isSymmetricKeyDecryptionAllowed

public java.lang.Boolean isSymmetricKeyDecryptionAllowed()

whether this use domain is available for decryption; if false, these keys should not be used for decrypting messages

Returns:

symmetricKeyDecryptionAllowed

setSymmetricKeyDecryptionAllowed

public void setSymmetricKeyDecryptionAllowed(java.lang.Boolean symmetricKeyDecryptionAllowed)

symmetricKeyRetentionUseTTL

public SymmetricKeyUseDomain symmetricKeyRetentionUseTTL(java.lang.Integer symmetricKeyRetentionUseTTL)

getSymmetricKeyRetentionUseTTL

public java.lang.Integer getSymmetricKeyRetentionUseTTL()

number of seconds since key creation that the key will be available for retention purposes

Returns:

symmetricKeyRetentionUseTTL

setSymmetricKeyRetentionUseTTL

public void setSymmetricKeyRetentionUseTTL(java.lang.Integer symmetricKeyRetentionUseTTL)

symmetricKeyLength

public SymmetricKeyUseDomain symmetricKeyLength(java.lang.Integer symmetricKeyLength)

getSymmetricKeyLength

public java.lang.Integer getSymmetricKeyLength()

the number of bits of all symmetric keys in this use domain

Returns:

symmetricKeyLength

setSymmetricKeyLength

public void setSymmetricKeyLength(java.lang.Integer symmetricKeyLength)

symmetricKeyEncryptionAlg

public SymmetricKeyUseDomain symmetricKeyEncryptionAlg(java.lang.String symmetricKeyEncryptionAlg)

getSymmetricKeyEncryptionAlg

public java.lang.String getSymmetricKeyEncryptionAlg()

the specific encryption alg to encrypt new plaintexts for application layer encryption operations

Returns:

symmetricKeyEncryptionAlg

setSymmetricKeyEncryptionAlg

public void setSymmetricKeyEncryptionAlg(java.lang.String symmetricKeyEncryptionAlg)

encryptingPackagedCiphertextVersion

public SymmetricKeyUseDomain encryptingPackagedCiphertextVersion(java.lang.Integer encryptingPackagedCiphertextVersion)

getEncryptingPackagedCiphertextVersion

public java.lang.Integer getEncryptingPackagedCiphertextVersion()

after encrypting new plaintexts, package the ciphertext with this version of the packaged ciphertext

Returns:

encryptingPackagedCiphertextVersion

setEncryptingPackagedCiphertextVersion

public void setEncryptingPackagedCiphertextVersion(java.lang.Integer encryptingPackagedCiphertextVersion)

symmetricKeyDerivationServiceId

public SymmetricKeyUseDomain symmetricKeyDerivationServiceId(java.lang.String symmetricKeyDerivationServiceId)

getSymmetricKeyDerivationServiceId

public java.lang.String getSymmetricKeyDerivationServiceId()

the symmetric key derivation serivce id that can derive and wrap these keys

Returns:

symmetricKeyDerivationServiceId

setSymmetricKeyDerivationServiceId

public void setSymmetricKeyDerivationServiceId(java.lang.String symmetricKeyDerivationServiceId)

encryptionKeyIds

public SymmetricKeyUseDomain encryptionKeyIds(java.util.List<java.lang.String> encryptionKeyIds)

addEncryptionKeyIdsItem

public SymmetricKeyUseDomain addEncryptionKeyIdsItem(java.lang.String encryptionKeyIdsItem)

getEncryptionKeyIds

public java.util.List<java.lang.String> getEncryptionKeyIds()

these are the semmetric key id's that belong to this use domain - these keys never belong to any other use domain

Returns:

encryptionKeyIds

setEncryptionKeyIds

public void setEncryptionKeyIds(java.util.List<java.lang.String> encryptionKeyIds)

endableKDSFallbackToCloud

public SymmetricKeyUseDomain endableKDSFallbackToCloud(java.lang.Boolean endableKDSFallbackToCloud)

isEndableKDSFallbackToCloud

public java.lang.Boolean isEndableKDSFallbackToCloud()

if all registered kds service become unreachable, then incoming requests for new and existing keys may fallback to the cloud provided KDS

Returns:

endableKDSFallbackToCloud

setEndableKDSFallbackToCloud

public void setEndableKDSFallbackToCloud(java.lang.Boolean endableKDSFallbackToCloud)

requireSignedKeyDelivery

public SymmetricKeyUseDomain requireSignedKeyDelivery(java.lang.Boolean requireSignedKeyDelivery)

isRequireSignedKeyDelivery

public java.lang.Boolean isRequireSignedKeyDelivery()

if required, all clients must receive these keys in a signed symmetric key delivery from the key deriver

Returns:

requireSignedKeyDelivery

setRequireSignedKeyDelivery

public void setRequireSignedKeyDelivery(java.lang.Boolean requireSignedKeyDelivery)

digestAlgorithm

public SymmetricKeyUseDomain digestAlgorithm(java.lang.String digestAlgorithm)

getDigestAlgorithm

public java.lang.String getDigestAlgorithm()

The digest algorithm to use for signing messages in this use domain

Returns:

digestAlgorithm

setDigestAlgorithm

public void setDigestAlgorithm(java.lang.String digestAlgorithm)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object