Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class ReservedStateMetadata.Builder

java.lang.Object

org.elasticsearch.cluster.metadata.ReservedStateMetadata.Builder

Enclosing class:

ReservedStateMetadata

public static class ReservedStateMetadata.Builder
extends Object

Builder class for ReservedStateMetadata

Constructor Summary

Constructors

Constructor	Description
Builder(String namespace)	Empty builder for ReservedStateMetadata.
Builder(String namespace, ReservedStateMetadata metadata)	Creates an reserved state metadata builder
Builder(ReservedStateMetadata metadata)	Creates an reserved state metadata builder

Method Summary

Modifier and Type	Method	Description
ReservedStateMetadata	build()	Builds an ReservedStateMetadata from this builder.
ReservedStateMetadata.Builder	errorMetadata(ReservedStateErrorMetadata errorMetadata)	Adds ReservedStateErrorMetadata if we need to store error information about certain reserved state processing.
ReservedStateHandlerMetadata	getHandler(String handlerName)	Returns the current handler metadata stored in the builder
ReservedStateMetadata.Builder	putHandler(ReservedStateHandlerMetadata handler)	Adds an ReservedStateHandlerMetadata for this ReservedStateMetadata.
ReservedStateMetadata.Builder	version(Long version)	Stores the version for the reserved state metadata.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String namespace)

Empty builder for ReservedStateMetadata.

The reserved metadata namespace is a required parameter

Parameters:

namespace - The namespace for this reserved metadata

Builder

public Builder(ReservedStateMetadata metadata)

Creates an reserved state metadata builder

Parameters:

metadata - the previous metadata

Builder

public Builder(String namespace,
 ReservedStateMetadata metadata)

Creates an reserved state metadata builder

Parameters:

namespace - the namespace for which we are storing metadata, e.g. file_settings

metadata - the previous metadata

Method Details

version

public ReservedStateMetadata.Builder version(Long 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

public ReservedStateMetadata.Builder errorMetadata(ReservedStateErrorMetadata errorMetadata)

Adds ReservedStateErrorMetadata if we need to store error information about certain reserved state processing.

Parameters:

errorMetadata - ReservedStateErrorMetadata

Returns:

ReservedStateMetadata.Builder

putHandler

public ReservedStateMetadata.Builder putHandler(ReservedStateHandlerMetadata handler)

Adds an ReservedStateHandlerMetadata for this ReservedStateMetadata.

The handler metadata is stored in a map, keyed off the ReservedStateHandlerMetadata name. Previously stored ReservedStateHandlerMetadata for a given name is overwritten.

Parameters:

handler - ReservedStateHandlerMetadata

Returns:

ReservedStateMetadata.Builder

getHandler

public ReservedStateHandlerMetadata getHandler(String handlerName)

Returns the current handler metadata stored in the builder

build

public ReservedStateMetadata build()

Builds an ReservedStateMetadata from this builder.

Returns:

ReservedStateMetadata