com.ibm.cloud.ibm_key_protect_api.v2.model

Class KeyRepresentation

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.KeyRepresentation

All Implemented Interfaces:

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

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

Additional properties that describe a key.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyRepresentation.AlgorithmMode The encryption scheme used to generate the key.
static interface	KeyRepresentation.AlgorithmType The algorithm type used to generate the key.

Constructor Summary

Constructors

Constructor and Description
KeyRepresentation()

Method Summary

Modifier and Type	Method and Description
Long	getAlgorithmBitSize() Gets the algorithmBitSize.
KeyRepresentationAlgorithmMetadata	getAlgorithmMetadata() Gets the algorithmMetadata.
String	getAlgorithmMode() Gets the algorithmMode.
String	getAlgorithmType() Gets the algorithmType.
String	getCreatedBy() Gets the createdBy.
Date	getCreationDate() Gets the creationDate.
String	getCrn() Gets the crn.
String	getDescription() Gets the description.
DualAuthKeyMetadata	getDualAuthDelete() Gets the dualAuthDelete.
Date	getExpirationDate() Gets the expirationDate.
String	getId() Gets the id.
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.
Long	getState() Gets the state.
List<String>	getTags() Gets the tags.
String	getType() Gets the type.
Boolean	isExtractable() Gets the extractable.
Boolean	isImported() Gets the imported.

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

Constructor Detail

KeyRepresentation

public KeyRepresentation()

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 unique, human-readable alias to assign to your key. To protect your privacy, do not use personal data, such as your name or location, as an alias for your key.

Returns:

the name

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 2-30 characters, including spaces. Special characters not permitted include the angled bracket, 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

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

public String getAlgorithmType()

Gets the algorithmType. The algorithm type used to generate the key. Currently, AES is supported.

Returns:

the algorithmType

getAlgorithmMetadata

public KeyRepresentationAlgorithmMetadata getAlgorithmMetadata()

Gets the algorithmMetadata. The metadata for the key algorithm.

Returns:

the algorithmMetadata

getAlgorithmBitSize

public Long getAlgorithmBitSize()

Gets the algorithmBitSize. The algorithm bit size used for key encryption.

Returns:

the algorithmBitSize

getAlgorithmMode

public String getAlgorithmMode()

Gets the algorithmMode. The encryption scheme used to generate the key. Currently, `CBC_PAD` is supported.

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