Module org.elasticsearch.server

Package org.elasticsearch.cluster.project

Class ProjectStateRegistry

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>

org.elasticsearch.cluster.project.ProjectStateRegistry

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public class ProjectStateRegistry
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

Represents a registry for managing and retrieving project-specific state in the cluster state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectStateRegistry.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ProjectStateRegistry	EMPTY
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
ProjectStateRegistry(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static ProjectStateRegistry.Builder	builder()
static ProjectStateRegistry.Builder	builder(ClusterState original)
static ProjectStateRegistry.Builder	builder(ProjectStateRegistry projectRegistry)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
static Settings	getProjectSettings(ProjectId projectId, ClusterState clusterState)	Retrieves the settings for a specific project based on its project ID from the specified cluster state without creating a new object.
String	getWriteableName()	Returns the name of the writeable object
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
int	size()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.cluster.ClusterState.Custom

isPrivate

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

EMPTY

public static final ProjectStateRegistry EMPTY

Constructor Details

ProjectStateRegistry

public ProjectStateRegistry(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

getProjectSettings

public static Settings getProjectSettings(ProjectId projectId,
 ClusterState clusterState)

Retrieves the settings for a specific project based on its project ID from the specified cluster state without creating a new object. If you need a full state of the project rather than just its setting, please use ClusterState.projectState(ProjectId)

Parameters:

projectId - id of the project

clusterState - cluster state

Returns:

the settings for the specified project, or an empty settings object if no settings are found

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ClusterState.Custom

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface ClusterState.Custom

Returns:

iterator over chunks of ToXContent

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in)
                                                   throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

size

public int size()

builder

public static ProjectStateRegistry.Builder builder(ClusterState original)

builder

public static ProjectStateRegistry.Builder builder(ProjectStateRegistry projectRegistry)

builder

public static ProjectStateRegistry.Builder builder()