Package com.microsoft.azure.keyvault.requests

Class UpdateKeyRequest.Builder

java.lang.Object

com.microsoft.azure.keyvault.requests.UpdateKeyRequest.Builder

Enclosing class:

UpdateKeyRequest

public static class UpdateKeyRequest.Builder
extends Object

The UpdateKeyRequest builder.

Constructor Summary

Constructors

Constructor	Description
Builder(String keyIdentifier)	The builder for constructing UpdateKeyRequest object.
Builder(String vaultBaseUrl, String keyName)	The builder for constructing UpdateKeyRequest object.

Method Summary

Modifier and Type	Method	Description
UpdateKeyRequest	build()	builds the UpdateKeyRequest object.
UpdateKeyRequest.Builder	withAttributes(Attributes attributes)	Set the key attributes value.
UpdateKeyRequest.Builder	withKeyOperations(List<JsonWebKeyOperation> keyOperations)	Set the key operations value.
UpdateKeyRequest.Builder	withTags(Map<String,String> tags)	Set the tags value.
UpdateKeyRequest.Builder	withVersion(String keyVersion)	Set the key version value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String vaultBaseUrl,
               String keyName)

The builder for constructing UpdateKeyRequest object.

Parameters:

vaultBaseUrl - The vault name, e.g. https://myvault.vault.azure.net.

keyName - The name of the key in the given vault.

Builder

public Builder(String keyIdentifier)

The builder for constructing UpdateKeyRequest object.

Parameters:

keyIdentifier - The key identifier, e.g. https://{vault-name}.vault.azure.net/keys/{key-name}/{key- version}.

Method Detail

withVersion

public UpdateKeyRequest.Builder withVersion(String keyVersion)

Set the key version value.

Parameters:

keyVersion - the key version.

Returns:

the Builder object itself.

withKeyOperations

public UpdateKeyRequest.Builder withKeyOperations(List<JsonWebKeyOperation> keyOperations)

Set the key operations value.

Parameters:

keyOperations - the key operation list

Returns:

the Builder object itself.

withAttributes

public UpdateKeyRequest.Builder withAttributes(Attributes attributes)

Set the key attributes value.

Parameters:

attributes - the key management attributes value to set

Returns:

the Builder object itself.

withTags

public UpdateKeyRequest.Builder withTags(Map<String,String> tags)

Set the tags value.

Parameters:

tags - Application-specific metadata in the form of key-value pairs.

Returns:

the Builder object itself.

build

public UpdateKeyRequest build()

builds the UpdateKeyRequest object.

Returns:

the UpdateKeyRequest object.