com.azure.security.keyvault.keys.models

Class KeyCreateOptions

java.lang.Object

com.azure.security.keyvault.keys.models.KeyCreateOptions

Direct Known Subclasses:

EcKeyCreateOptions, RsaKeyCreateOptions

public class KeyCreateOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
KeyCreateOptions(String name, KeyType keyType) Creates instance of KeyCreateOptions with name as key name and keyType as type of the key.

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	getExpires() Get the Key Expiry time in UTC.
KeyType	getKeyType() Get the key type.
String	getName() Get the key name.
OffsetDateTime	getNotBefore() Get the notBefore UTC time.
Map<String,String>	getTags() Get the tags associated with the key.
Boolean	isEnabled() Get the enabled value.
List<KeyOperation>	keyOperations() Get the key operations.
KeyCreateOptions	setEnabled(Boolean enabled) Set the enabled value.
KeyCreateOptions	setExpires(OffsetDateTime expires) Set the expires UTC time.
KeyCreateOptions	setKeyOperations(KeyOperation... keyOperations) Set the key operations value.
KeyCreateOptions	setNotBefore(OffsetDateTime notBefore) Set the notBefore UTC time.
KeyCreateOptions	setTags(Map<String,String> tags) Set the tags to be associated with the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyCreateOptions

public KeyCreateOptions(String name,
                        KeyType keyType)

Creates instance of KeyCreateOptions with name as key name and keyType as type of the key.

Parameters:

name - The name of the key to create.

keyType - The type of the key to create.

Method Detail

keyOperations

public List<KeyOperation> keyOperations()

Get the key operations.

Returns:

the key operations.

setKeyOperations

public KeyCreateOptions setKeyOperations(KeyOperation... keyOperations)

Set the key operations value.

Parameters:

keyOperations - The key operations value to set

Returns:

the KeyCreateOptions object itself.

getKeyType

public KeyType getKeyType()

Get the key type.

Returns:

the key type.

setNotBefore

public KeyCreateOptions setNotBefore(OffsetDateTime notBefore)

Set the notBefore UTC time.

Parameters:

notBefore - The notBefore UTC time to set

Returns:

the KeyCreateOptions object itself.

getNotBefore

public OffsetDateTime getNotBefore()

Get the notBefore UTC time.

Returns:

the notBefore UTC time.

setExpires

public KeyCreateOptions setExpires(OffsetDateTime expires)

Set the expires UTC time.

Parameters:

expires - The expiry time to set for the key.

Returns:

the KeyCreateOptions object itself.

getExpires

public OffsetDateTime getExpires()

Get the Key Expiry time in UTC.

Returns:

the expires UTC time.

setTags

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

Set the tags to be associated with the key.

Parameters:

tags - The tags to set

Returns:

the KeyCreateOptions object itself.

getTags

public Map<String,String> getTags()

Get the tags associated with the key.

Returns:

the value of the tags.

setEnabled

public KeyCreateOptions setEnabled(Boolean enabled)

Set the enabled value.

Parameters:

enabled - The enabled value to set

Returns:

the KeyCreateOptions object itself.

isEnabled

public Boolean isEnabled()

Get the enabled value.

Returns:

the enabled value

getName

public String getName()

Get the key name.

Returns:

the name of the key.