keyPurpose (property)
The key's purpose.
Syntax
- (int)keyPurpose:(int)keyIndex;
/* Possible Values */
GKP_UNSPECIFIED(0),
GKP_ENCRYPT_DECRYPT(1),
GKP_ASYMMETRIC_SIGN(2),
GKP_ASYMMETRIC_DECRYPT(3)
public func keyPurpose(keyIndex: Int32) throws -> GooglekmsKeyPurposes
public enum GooglekmsKeyPurposes : Int32 { case gkpUnspecified = 0 case gkpEncryptDecrypt = 1 case gkpAsymmetricSign = 2 case gkpAsymmetricDecrypt = 3 }
Default Value
0
Remarks
The key's purpose.
This property reflects the key's purpose. Possible values are:
- gkpUnspecified (0)
- gkpEncryptDecrypt (1) (indicates the key is symmetric)
- gkpAsymmetricSign (2)
- gkpAsymmetricDecrypt (3)
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.
This property is read-only.