Module org.elasticsearch.server
Class ReservedStateMetadata.Builder
java.lang.Object
org.elasticsearch.cluster.metadata.ReservedStateMetadata.Builder
- Enclosing class:
ReservedStateMetadata
Builder class for
ReservedStateMetadata-
Constructor Summary
ConstructorsConstructorDescriptionEmpty builder for ReservedStateMetadata.Builder(String namespace, ReservedStateMetadata metadata) Creates an reserved state metadata builderBuilder(ReservedStateMetadata metadata) Creates an reserved state metadata builder -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds anReservedStateMetadatafrom this builder.errorMetadata(ReservedStateErrorMetadata errorMetadata) AddsReservedStateErrorMetadataif we need to store error information about certain reserved state processing.getHandler(String handlerName) Returns the current handler metadata stored in the builderputHandler(ReservedStateHandlerMetadata handler) Adds anReservedStateHandlerMetadatafor thisReservedStateMetadata.Stores the version for the reserved state metadata.
-
Constructor Details
-
Builder
Empty builder for ReservedStateMetadata.The reserved metadata namespace is a required parameter
- Parameters:
namespace- The namespace for this reserved metadata
-
Builder
Creates an reserved state metadata builder- Parameters:
metadata- the previous metadata
-
Builder
Creates an reserved state metadata builder- Parameters:
namespace- the namespace for which we are storing metadata, e.g. file_settingsmetadata- the previous metadata
-
-
Method Details
-
version
Stores the version for the reserved state metadata.Each new reserved cluster state update mode requires a version bump. The version increase doesn't have to be monotonic.
- Parameters:
version- the new reserved state metadata version- Returns:
ReservedStateMetadata.Builder
-
errorMetadata
AddsReservedStateErrorMetadataif we need to store error information about certain reserved state processing.- Parameters:
errorMetadata-ReservedStateErrorMetadata- Returns:
ReservedStateMetadata.Builder
-
putHandler
Adds anReservedStateHandlerMetadatafor thisReservedStateMetadata.The handler metadata is stored in a map, keyed off the
ReservedStateHandlerMetadataname. Previously storedReservedStateHandlerMetadatafor a given name is overwritten.- Parameters:
handler-ReservedStateHandlerMetadata- Returns:
ReservedStateMetadata.Builder
-
getHandler
Returns the current handler metadata stored in the builder -
build
Builds anReservedStateMetadatafrom this builder.- Returns:
ReservedStateMetadata
-