Package co.elastic.clients.elasticsearch.cluster.stats

Class ClusterFileSystem

java.lang.Object

co.elastic.clients.elasticsearch.cluster.stats.ClusterFileSystem

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ClusterFileSystem
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterFileSystem.Builder	Builder for ClusterFileSystem.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ClusterFileSystem>	_DESERIALIZER	Json deserializer for ClusterFileSystem

Method Summary

Modifier and Type	Method	Description
final long	availableInBytes()	Required - Total number of bytes available to JVM in file stores across all selected nodes.
final long	freeInBytes()	Required - Total number of unallocated bytes in file stores across all selected nodes.
static ClusterFileSystem	of(Function<ClusterFileSystem.Builder,ObjectBuilder<ClusterFileSystem>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupClusterFileSystemDeserializer(ObjectDeserializer<ClusterFileSystem.Builder> op)
String	toString()
final long	totalInBytes()	Required - Total size, in bytes, of all file stores across all selected nodes.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ClusterFileSystem> _DESERIALIZER

Json deserializer for ClusterFileSystem

Method Details

of

public static ClusterFileSystem of(Function<ClusterFileSystem.Builder,ObjectBuilder<ClusterFileSystem>> fn)

availableInBytes

public final long availableInBytes()

Required - Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use.

API name: available_in_bytes

freeInBytes

public final long freeInBytes()

Required - Total number of unallocated bytes in file stores across all selected nodes.

API name: free_in_bytes

totalInBytes

public final long totalInBytes()

Required - Total size, in bytes, of all file stores across all selected nodes.

API name: total_in_bytes

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupClusterFileSystemDeserializer

protected static void setupClusterFileSystemDeserializer(ObjectDeserializer<ClusterFileSystem.Builder> op)