com.ibm.cloud.ibm_key_protect_api.v2.model

Class KeyWithPayload

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.KeyWithPayload

All Implemented Interfaces:

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

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

Properties returned only for DELETE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyWithPayload.AlgorithmMode Deprecated.
static interface	KeyWithPayload.AlgorithmType Deprecated.
static interface	KeyWithPayload.Type Specifies the MIME type that represents the key resource.

Method Summary

Modifier and Type	Method and Description
Long	getAlgorithmBitSize() Deprecated. this method is deprecated and may be removed in a future release
KeyWithPayloadAlgorithmMetadata	getAlgorithmMetadata() Gets the algorithmMetadata.
String	getAlgorithmMode() Deprecated. this method is deprecated and may be removed in a future release
String	getAlgorithmType() Deprecated. this method is deprecated and may be removed in a future release
List<String>	getAliases() Gets the aliases.
String	getCreatedBy() Gets the createdBy.
Date	getCreationDate() Gets the creationDate.
String	getCrn() Gets the crn.
String	getDeletedBy() Gets the deletedBy.
Date	getDeletionDate() Gets the deletionDate.
String	getDescription() Gets the description.
DualAuthKeyMetadata	getDualAuthDelete() Gets the dualAuthDelete.
Date	getExpirationDate() Gets the expirationDate.
String	getId() Gets the id.
String	getKeyRingId() Gets the keyRingId.
KeyVersion	getKeyVersion() Gets the keyVersion.
Date	getLastRotateDate() Gets the lastRotateDate.
Date	getLastUpdateDate() Gets the lastUpdateDate.
String	getName() Gets the name.
Long	getNonactiveStateReason() Gets the nonactiveStateReason.
byte[]	getPayload() Gets the payload.
Date	getPurgeAllowedFrom() Gets the purgeAllowedFrom.
Date	getPurgeScheduledOn() Gets the purgeScheduledOn.
Date	getRestoreExpirationDate() Gets the restoreExpirationDate.
RotationKeyMetadata	getRotation() Gets the rotation.
Long	getState() Gets the state.
List<String>	getTags() Gets the tags.
String	getType() Gets the type.
Boolean	isDeleted() Gets the deleted.
Boolean	isExtractable() Gets the extractable.
Boolean	isImported() Gets the imported.
Boolean	isPurgeAllowed() Gets the purgeAllowed.
Boolean	isRestoreAllowed() Gets the restoreAllowed.

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

getType

public String getType()

Gets the type. Specifies the MIME type that represents the key resource. Currently, only the default is supported.

Returns:

the type

getId

public String getId()

Gets the id. The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.

Returns:

the id

getName

public String getName()

Gets the name. A human-readable name assigned to your key for convenience. To protect your privacy do not use personal data, such as your name or location, as the name for your key.

Returns:

the name

getAliases

public List<String> getAliases()

Gets the aliases. One or more, up to a total of five, human-readable unique aliases assigned to your key. To protect your privacy do not use personal data, such as your name or location, as an alias for your key. Each alias must be alphanumeric and cannot contain spaces or special characters other than `-` or `_`. The alias cannot be a UUID and must not be a Key Protect reserved name: `allowed_ip`, `key`, `keys`, `metadata`, `policy`, `policies`, `registration`, `registrations`, `ring`, `rings`, `rotate`, `wrap`, `unwrap`, `rewrap`, `version`, `versions`.

Returns:

the aliases

getDescription

public String getDescription()

Gets the description. A text field used to provide a more detailed description of the key. 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 key.

Returns:

the description

getTags

public List<String> getTags()

Gets the tags. Up to 30 tags can be created. Tags can be between 0-30 characters, including spaces. Special characters not permitted include angled brackets, comma, colon, ampersand, and vertical pipe character (|). To protect your privacy, do not use personal data, such as your name or location, as a tag for your key.

Returns:

the tags

getState

public Long getState()

Gets the state. The key state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

Returns:

the state

getExpirationDate

public Date getExpirationDate()

Gets the expirationDate. The date the key material expires. The date format follows RFC 3339. You can set an expiration date on any key on its creation. If you create a key without specifying an expiration date, the key does not expire.

Returns:

the expirationDate

isExtractable

public Boolean isExtractable()

Gets the extractable. A boolean that determines whether the key material can leave the service. If set to `false`, Key Protect designates the key as a nonextractable root key used for `wrap` and `unwrap` actions. If set to `true`, Key Protect designates the key as a standard key that you can store in your apps and services. Once set to `false` it cannot be changed to `true`.

Returns:

the extractable

getCrn

public String getCrn()

Gets the crn. The Cloud Resource Name (CRN) that uniquely identifies your cloud resources.

Returns:

the crn

isImported

public Boolean isImported()

Gets the imported. A boolean that shows whether your key was originally imported or generated in Key Protect. The value is set by Key Protect based on how the key material is initially added to the service. A value of `true` indicates that you must provide new key material when it's time to rotate the key. A value of `false` indicates that Key Protect will generate the new key material on a `rotate` operation, as it did in key creation.

Returns:

the imported

getKeyRingId

public String getKeyRingId()

Gets the keyRingId. An ID that identifies the key ring. Each ID is unique only within the given instance and is not reserved across the Key Protect service.

Returns:

the keyRingId

getCreationDate

public Date getCreationDate()

Gets the creationDate. The date the key material was created. The date format follows RFC 3339.

Returns:

the creationDate

getCreatedBy

public String getCreatedBy()

Gets the createdBy. The unique identifier for the resource that created the key.

Returns:

the createdBy

getAlgorithmType

@Deprecated
public String getAlgorithmType()

Deprecated. this method is deprecated and may be removed in a future release

Gets the algorithmType. Deprecated.

Returns:

the algorithmType

getAlgorithmMetadata

public KeyWithPayloadAlgorithmMetadata getAlgorithmMetadata()

Gets the algorithmMetadata. Deprecated.

Returns:

the algorithmMetadata

getAlgorithmBitSize

@Deprecated
public Long getAlgorithmBitSize()

Deprecated. this method is deprecated and may be removed in a future release

Gets the algorithmBitSize. Deprecated.

Returns:

the algorithmBitSize

getAlgorithmMode

@Deprecated
public String getAlgorithmMode()

Deprecated. this method is deprecated and may be removed in a future release

Gets the algorithmMode. Deprecated.

Returns:

the algorithmMode

getNonactiveStateReason

public Long getNonactiveStateReason()

Gets the nonactiveStateReason. A code indicating the reason the key is not in the activation state.

Returns:

the nonactiveStateReason

getLastUpdateDate

public Date getLastUpdateDate()

Gets the lastUpdateDate. Updates when any part of the key metadata is modified. The date format follows RFC 3339.

Returns:

the lastUpdateDate

getLastRotateDate

public Date getLastRotateDate()

Gets the lastRotateDate. Updates to show when the key was last rotated. The date format follows RFC 3339.

Returns:

the lastRotateDate

getKeyVersion

public KeyVersion getKeyVersion()

Gets the keyVersion. Properties associated with a specific key version.

Returns:

the keyVersion

getDualAuthDelete

public DualAuthKeyMetadata getDualAuthDelete()

Gets the dualAuthDelete. Metadata that indicates the status of a dual authorization policy on the key.

Returns:

the dualAuthDelete

getRotation

public RotationKeyMetadata getRotation()

Gets the rotation. Metadata that indicates the status of a rotation policy on the key.

Returns:

the rotation

isDeleted

public Boolean isDeleted()

Gets the deleted. A boolean that determines whether the key has been deleted.

Returns:

the deleted

getDeletionDate

public Date getDeletionDate()

Gets the deletionDate. The date the key material was destroyed. The date format follows RFC 3339.

Returns:

the deletionDate

getDeletedBy

public String getDeletedBy()

Gets the deletedBy. The unique identifier for the resource that deleted the key.

Returns:

the deletedBy

getRestoreExpirationDate

public Date getRestoreExpirationDate()

Gets the restoreExpirationDate. The date the key will no longer have the ability to be restored.

Returns:

the restoreExpirationDate

isRestoreAllowed

public Boolean isRestoreAllowed()

Gets the restoreAllowed. A boolean that specifies if your key has the ability to be restored. A value of `true` indicates that the key can be restored. A value of `false` indicates that the key is unable to be restored.

Returns:

the restoreAllowed

isPurgeAllowed

public Boolean isPurgeAllowed()

Gets the purgeAllowed. A boolean that specifies if the key can be purged. A value of `true` indicates that the key can be purged. A value of `false` indicates that the key is within the purge wait period and is not ready to be purged.

Returns:

the purgeAllowed

getPurgeAllowedFrom

public Date getPurgeAllowedFrom()

Gets the purgeAllowedFrom. The date the key will be ready to be purged.

Returns:

the purgeAllowedFrom

getPurgeScheduledOn

public Date getPurgeScheduledOn()

Gets the purgeScheduledOn. The date the deleted key will be automatically purged from Key Protect system.

Returns:

the purgeScheduledOn

getPayload

public byte[] getPayload()

Gets the payload. The key material that you can export to external apps or services. **Note:** If the key has been designated as a root key, the system cannot return the key material.

Returns:

the payload