Package org.opensearch.client.opensearch.cluster.stats

Class ClusterFileSystem

java.lang.Object
org.opensearch.client.opensearch.cluster.stats.ClusterFileSystem
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class ClusterFileSystem extends Object implements PlainJsonSerializable, ToCopyableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>

  • Field Details

  • Method Details

    • of

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

    • available

      @Nullable public final String available()
      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 OpenSearch nodes can use.

      API name: available

    • 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 OpenSearch nodes can use.

      API name: available_in_bytes

    • cacheReserved

      @Nullable public final String cacheReserved()
      Total size, of all cache reserved across all selected nodes.

      API name: cache_reserved

    • cacheReservedInBytes

      @Nullable public final Long cacheReservedInBytes()
      Total size, in bytes, of all cache reserved across all selected nodes.

      API name: cache_reserved_in_bytes

    • free

      @Nullable public final String free()
      Total number of unallocated bytes in file stores across all selected nodes.

      API name: free

    • freeInBytes

      public final long freeInBytes()
      Required - Total number of unallocated bytes in file stores across all selected nodes.

      API name: free_in_bytes

    • total

      @Nullable public final String total()
      Total size, of all file stores across all selected nodes.

      API name: total

    • 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)

    • toBuilder

      @Nonnull public ClusterFileSystem.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ClusterFileSystem.Builder builder()

    • setupClusterFileSystemDeserializer

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object