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

Class ClusterFileSystem.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.cluster.stats.ClusterFileSystem.Builder
All Implemented Interfaces:
CopyableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>, MutableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>, ObjectBuilder<ClusterFileSystem>
Enclosing class:
ClusterFileSystem
public static class ClusterFileSystem.Builder extends ObjectBuilderBase implements CopyableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>
Builder for ClusterFileSystem.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public ClusterFileSystem.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<ClusterFileSystem.Builder,ClusterFileSystem>
      Returns:
      a new builder instance.

    • available

      @Nonnull public final ClusterFileSystem.Builder available(@Nullable String value)
      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

      @Nonnull public final ClusterFileSystem.Builder availableInBytes(long value)
      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

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

      API name: cache_reserved

    • cacheReservedInBytes

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

      API name: cache_reserved_in_bytes

    • free

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

      API name: free

    • freeInBytes

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

      API name: free_in_bytes

    • total

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

      API name: total

    • totalInBytes

      @Nonnull public final ClusterFileSystem.Builder totalInBytes(long value)
      Required - Total size, in bytes, of all file stores across all selected nodes.

      API name: total_in_bytes

    • build

      @Nonnull public ClusterFileSystem build()
      Builds a ClusterFileSystem.
      Specified by:
      build in interface ObjectBuilder<ClusterFileSystem>
      Throws:
      NullPointerException - if some of the required fields are null.