Package org.opensearch.client.opensearch.nodes.stats

Class FileSystemTotal.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public FileSystemTotal.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<FileSystemTotal.Builder,FileSystemTotal>
      Returns:
      a new builder instance.

    • available

      @Nonnull public final FileSystemTotal.Builder available(@Nullable String value)
      Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the OpenSearch node can utilize.

      API name: available

    • availableInBytes

      @Nonnull public final FileSystemTotal.Builder availableInBytes(@Nullable Long value)
      Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free_in_bytes. This is the actual amount of free disk space the OpenSearch node can utilize.

      API name: available_in_bytes

    • cacheReserved

      @Nonnull public final FileSystemTotal.Builder cacheReserved(@Nullable String value)
      Total size of cache bytes reserved in all file stores.

      API name: cache_reserved

    • cacheReservedInBytes

      @Nonnull public final FileSystemTotal.Builder cacheReservedInBytes(@Nullable Long value)
      Total size of cache bytes reserved in all file stores.

      API name: cache_reserved_in_bytes

    • free

      @Nonnull public final FileSystemTotal.Builder free(@Nullable String value)
      Total unallocated disk space in all file stores.

      API name: free

    • freeInBytes

      @Nonnull public final FileSystemTotal.Builder freeInBytes(@Nullable Long value)
      Total number of unallocated bytes in all file stores.

      API name: free_in_bytes

    • total

      @Nonnull public final FileSystemTotal.Builder total(@Nullable String value)
      Total size of all file stores.

      API name: total

    • totalInBytes

      @Nonnull public final FileSystemTotal.Builder totalInBytes(@Nullable Long value)
      Total size of all file stores in bytes.

      API name: total_in_bytes

    • build

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