Module io.helidon.integrations.vault.secrets.transit

Package io.helidon.integrations.vault.secrets.transit

Class UpdateKeyConfig.Request

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonBuilder<T>

io.helidon.integrations.common.rest.ApiJsonRequest<T>

io.helidon.integrations.vault.VaultRequest<UpdateKeyConfig.Request>

io.helidon.integrations.vault.secrets.transit.UpdateKeyConfig.Request

All Implemented Interfaces:

ApiRequest<UpdateKeyConfig.Request>

Enclosing class:

UpdateKeyConfig

public static final class UpdateKeyConfig.Request
extends VaultRequest<UpdateKeyConfig.Request>

Request object. Can be configured with additional headers, query parameters etc.

Method Summary

Modifier and Type	Method	Description
UpdateKeyConfig.Request	allowDeletion(boolean allowed)	Specifies if the key is allowed to be deleted.
UpdateKeyConfig.Request	allowPlaintextBackup(boolean allowBackup)	If set, enables taking backup of named key in the plaintext format.
static UpdateKeyConfig.Request	builder()	Fluent API builder for configuring a request.
UpdateKeyConfig.Request	exportable(boolean exportable)	Enables keys to be exportable.
UpdateKeyConfig.Request	minDecryptionVersion(int version)	Specifies the minimum version of ciphertext allowed to be decrypted.
UpdateKeyConfig.Request	minEncryptionVersion(int version)	Specifies the minimum version of the key that can be used to encrypt plaintext, sign payloads, or generate HMACs.
UpdateKeyConfig.Request	name(String name)	Specifies the name of the encryption key to create.

Methods inherited from class io.helidon.integrations.vault.VaultRequest

add, addCommaDelimitedArray, addToCommaDelimitedArray, durationToTtl, preBuild

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonRequest

addHeader, addQueryParam, headers, queryParams, requestId, requestId, requestMediaType, requestMediaType, responseMediaType, responseMediaType

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonBuilder

add, add, add, add, add, add, addBase64, addToArray, addToArray, addToArray, addToArray, addToArray, addToArray, addToObject, addToObject, addToObject, addToObject, addToObject, emptyArray, me, postBuild, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.integrations.common.rest.ApiRequest

toJson

Method Detail

builder

public static UpdateKeyConfig.Request builder()

Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(javax.json.JsonBuilderFactory) used by the RestApi.

Returns:

new request builder

name

public UpdateKeyConfig.Request name(String name)

Specifies the name of the encryption key to create.

Parameters:

name - key name

Returns:

updated request

minDecryptionVersion

public UpdateKeyConfig.Request minDecryptionVersion(int version)

Specifies the minimum version of ciphertext allowed to be decrypted. Adjusting this as part of a key rotation policy can prevent old copies of ciphertext from being decrypted, should they fall into the wrong hands. For signatures, this value controls the minimum version of signature that can be verified against. For HMACs, this controls the minimum version of a key allowed to be used as the key for verification.

Parameters:

version - version

Returns:

updated request

minEncryptionVersion

public UpdateKeyConfig.Request minEncryptionVersion(int version)

Specifies the minimum version of the key that can be used to encrypt plaintext, sign payloads, or generate HMACs. Must be 0 (which will use the latest version) or a value greater or equal to minDecryptionVersion(int).

Parameters:

version - version

Returns:

updated request

allowDeletion

public UpdateKeyConfig.Request allowDeletion(boolean allowed)

Specifies if the key is allowed to be deleted.

Parameters:

allowed - whether is is allowed to delete the key

Returns:

updated request

exportable

public UpdateKeyConfig.Request exportable(boolean exportable)

Enables keys to be exportable. This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

Parameters:

exportable - whether the key should be exportable

Returns:

updated request

allowPlaintextBackup

public UpdateKeyConfig.Request allowPlaintextBackup(boolean allowBackup)

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

Parameters:

allowBackup - whether to allow plaintext backup

Returns:

updated request