Package com.azure.security.keyvault.keys.models

Class CreateOkpKeyOptions

java.lang.Object

com.azure.security.keyvault.keys.models.CreateKeyOptions

com.azure.security.keyvault.keys.models.CreateOkpKeyOptions

public class CreateOkpKeyOptions
extends CreateKeyOptions

Represents the configurable options to create an octet key pair. Please refer to the specification for more information.

Constructor Summary

Constructors

Constructor	Description
CreateOkpKeyOptions(String name)	Creates a CreateOkpKeyOptions with name as name of the key.

Method Summary

Modifier and Type	Method	Description
KeyCurveName	getCurveName()	Get the curve.
Boolean	isHardwareProtected()	Get the HSM value of the key being created.
CreateOkpKeyOptions	setCurveName(KeyCurveName curveName)	Set the curve name.
CreateOkpKeyOptions	setEnabled(Boolean enabled)	Set a value that indicates if the key is enabled.
CreateOkpKeyOptions	setExpiresOn(OffsetDateTime expiresOn)	Set the expires UTC time.
CreateOkpKeyOptions	setExportable(Boolean exportable)	Set a flag that indicates if the private key can be exported.
CreateOkpKeyOptions	setHardwareProtected(Boolean hardwareProtected)	Set whether the key being created is of HSM type or not.
CreateOkpKeyOptions	setKeyOperations(KeyOperation... keyOperations)	Set the key operations.
CreateOkpKeyOptions	setNotBefore(OffsetDateTime notBefore)	Set the notBefore UTC time.
CreateOkpKeyOptions	setReleasePolicy(KeyReleasePolicy releasePolicy)	Set the policy rules under which the key can be exported.
CreateOkpKeyOptions	setTags(Map<String,String> tags)	Set the tags to be associated with the key.

Methods inherited from class com.azure.security.keyvault.keys.models.CreateKeyOptions

getExpiresOn, getKeyOperations, getKeyType, getName, getNotBefore, getReleasePolicy, getTags, isEnabled, isExportable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CreateOkpKeyOptions

public CreateOkpKeyOptions(String name)

Creates a CreateOkpKeyOptions with name as name of the key.

Parameters:

name - The name of the key.

Method Details

getCurveName

public KeyCurveName getCurveName()

Get the curve.

Returns:

The curve name.

setCurveName

public CreateOkpKeyOptions setCurveName(KeyCurveName curveName)

Set the curve name.

Parameters:

curveName - The curve name to set.

Returns:

The CreateOkpKeyOptions object.

setHardwareProtected

public CreateOkpKeyOptions setHardwareProtected(Boolean hardwareProtected)

Set whether the key being created is of HSM type or not.

Parameters:

hardwareProtected - The HSM value to set.

Returns:

The updated CreateOkpKeyOptions object.

isHardwareProtected

public Boolean isHardwareProtected()

Get the HSM value of the key being created.

Returns:

the HSM value.

setKeyOperations

public CreateOkpKeyOptions setKeyOperations(KeyOperation... keyOperations)

Set the key operations.

Overrides:

setKeyOperations in class CreateKeyOptions

Parameters:

keyOperations - The key operations to set.

Returns:

The updated CreateOkpKeyOptions object.

setNotBefore

public CreateOkpKeyOptions setNotBefore(OffsetDateTime notBefore)

Set the notBefore UTC time.

Overrides:

setNotBefore in class CreateKeyOptions

Parameters:

notBefore - The notBefore UTC time to set.

Returns:

The updated CreateOkpKeyOptions object.

setExpiresOn

public CreateOkpKeyOptions setExpiresOn(OffsetDateTime expiresOn)

Set the expires UTC time.

Overrides:

setExpiresOn in class CreateKeyOptions

Parameters:

expiresOn - The expiry time to set. for the key.

Returns:

The updated CreateOkpKeyOptions object.

setTags

public CreateOkpKeyOptions setTags(Map<String,String> tags)

Set the tags to be associated with the key.

Overrides:

setTags in class CreateKeyOptions

Parameters:

tags - The tags to set.

Returns:

The updated CreateOkpKeyOptions object.

setEnabled

public CreateOkpKeyOptions setEnabled(Boolean enabled)

Set a value that indicates if the key is enabled.

Overrides:

setEnabled in class CreateKeyOptions

Parameters:

enabled - The enabled value to set.

Returns:

The updated CreateOkpKeyOptions object.

setExportable

public CreateOkpKeyOptions setExportable(Boolean exportable)

Set a flag that indicates if the private key can be exported.

Overrides:

setExportable in class CreateKeyOptions

Parameters:

exportable - A flag that indicates if the private key can be exported.

Returns:

The updated CreateOkpKeyOptions object.

setReleasePolicy

public CreateOkpKeyOptions setReleasePolicy(KeyReleasePolicy releasePolicy)

Set the policy rules under which the key can be exported.

Overrides:

setReleasePolicy in class CreateKeyOptions

Parameters:

releasePolicy - The policy rules to set.

Returns:

The updated CreateOkpKeyOptions object.