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

Class CreateOctKeyOptions

java.lang.Object

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

com.azure.security.keyvault.keys.models.CreateOctKeyOptions

public class CreateOctKeyOptions
extends CreateKeyOptions

Represents the configurable options to create a symmetric key.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Integer	getKeySize()	Gets the key size in bits, such as 128, 192, or 256.
Boolean	isHardwareProtected()	Get the HSM value of the key being created.
CreateOctKeyOptions	setEnabled(Boolean enabled)	Set a value that indicates if the key is enabled.
CreateOctKeyOptions	setExpiresOn(OffsetDateTime expiresOn)	Set the expires UTC time.
CreateOctKeyOptions	setExportable(Boolean exportable)	Set a flag that indicates if the private key can be exported.
CreateOctKeyOptions	setHardwareProtected(Boolean hardwareProtected)	Set whether the key being created is of HSM type or not.
CreateOctKeyOptions	setKeyOperations(KeyOperation... keyOperations)	Set the key operations.
CreateOctKeyOptions	setKeySize(Integer keySize)	Sets the key size in bits, such as 128, 192, or 256.
CreateOctKeyOptions	setNotBefore(OffsetDateTime notBefore)	Set the notBefore UTC time.
CreateOctKeyOptions	setReleasePolicy(KeyReleasePolicy releasePolicy)	Set the policy rules under which the key can be exported.
CreateOctKeyOptions	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 Detail

CreateOctKeyOptions

public CreateOctKeyOptions(String name)

Creates a CreateOctKeyOptions with name as name of the key.

Parameters:

name - The name of the key.

Method Detail

setKeySize

public CreateOctKeyOptions setKeySize(Integer keySize)

Sets the key size in bits, such as 128, 192, or 256. If null, the service default is used.

Parameters:

keySize - The key size in bits to set.

Returns:

The updated CreateOctKeyOptions object.

getKeySize

public Integer getKeySize()

Gets the key size in bits, such as 128, 192, or 256.

Returns:

The key size in bits.

setHardwareProtected

public CreateOctKeyOptions 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 CreateOctKeyOptions object.

isHardwareProtected

public Boolean isHardwareProtected()

Get the HSM value of the key being created.

Returns:

the HSM value.

setKeyOperations

public CreateOctKeyOptions setKeyOperations(KeyOperation... keyOperations)

Set the key operations.

Overrides:

setKeyOperations in class CreateKeyOptions

Parameters:

keyOperations - The key operations to set.

Returns:

The updated CreateOctKeyOptions object.

setNotBefore

public CreateOctKeyOptions setNotBefore(OffsetDateTime notBefore)

Set the notBefore UTC time.

Overrides:

setNotBefore in class CreateKeyOptions

Parameters:

notBefore - The notBefore UTC time to set.

Returns:

The updated CreateOctKeyOptions object.

setExpiresOn

public CreateOctKeyOptions 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 CreateOctKeyOptions object.

setTags

public CreateOctKeyOptions 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 CreateOctKeyOptions object.

setEnabled

public CreateOctKeyOptions 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 CreateOctKeyOptions object.

setExportable

public CreateOctKeyOptions 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 CreateOctKeyOptions object.

setReleasePolicy

public CreateOctKeyOptions 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 CreateOctKeyOptions object.