Class Versioned.Metadata.MetadataBuilder

java.lang.Object

org.springframework.vault.support.Versioned.Metadata.MetadataBuilder

Enclosing class:

Versioned.Metadata

public static class Versioned.Metadata.MetadataBuilder
extends Object

Builder for Versioned.Metadata objects.

Since:

2.1

Author:

Mark Paluch, Jeroen Willemsen

Method Summary

Modifier and Type	Method	Description
Versioned.Metadata	build()	Build the Versioned.Metadata object.
Versioned.Metadata.MetadataBuilder	createdAt(Instant createdAt)	Configure a created at Instant.
Versioned.Metadata.MetadataBuilder	customMetadata(@Nullable Map<String,String> customMetadata)	Configure the custom metadata map.
Versioned.Metadata.MetadataBuilder	deletedAt(@Nullable Instant deletedAt)	Configure a deleted at Instant.
Versioned.Metadata.MetadataBuilder	destroyed()	Configure the version was destroyed.
Versioned.Metadata.MetadataBuilder	destroyed(boolean destroyed)	Configure the version was destroyed.
Versioned.Metadata.MetadataBuilder	version(Versioned.Version version)	Configure the Versioned.Version.

Methods inherited from class Object

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

Method Details

createdAt

public Versioned.Metadata.MetadataBuilder createdAt(Instant createdAt)

Configure a created at Instant.

Parameters:

createdAt - timestamp at which the version was created, must not be null.

Returns:

this Versioned.Metadata.MetadataBuilder.

deletedAt

public Versioned.Metadata.MetadataBuilder deletedAt(@Nullable Instant deletedAt)

Configure a deleted at Instant.

Parameters:

deletedAt - timestamp at which the version was deleted, must not be null.

Returns:

this Versioned.Metadata.MetadataBuilder.

destroyed

public Versioned.Metadata.MetadataBuilder destroyed()

Configure the version was destroyed.

Returns:

this Versioned.Metadata.MetadataBuilder.

destroyed

public Versioned.Metadata.MetadataBuilder destroyed(boolean destroyed)

Configure the version was destroyed.

Parameters:

destroyed -

Returns:

this Versioned.Metadata.MetadataBuilder.

version

public Versioned.Metadata.MetadataBuilder version(Versioned.Version version)

Configure the Versioned.Version.

Parameters:

version - must not be null.

Returns:

this Versioned.Metadata.MetadataBuilder.

customMetadata

public Versioned.Metadata.MetadataBuilder customMetadata(@Nullable Map<String,String> customMetadata)

Configure the custom metadata map.

Parameters:

customMetadata - must not be null and not empty.

Returns:

this Versioned.Metadata.MetadataBuilder.

Since:

3.1

build

public Versioned.Metadata build()

Build the Versioned.Metadata object. Requires createdAt(Instant) and version(Versioned.Version) to be set.

Returns:

the Versioned.Metadata object.