Package org.opensearch.client.opensearch.cat.allocation

Class AllocationRecord.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

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

    • diskAvail

      @Nonnull public final AllocationRecord.Builder diskAvail(@Nullable String value)
      Free disk space available to OpenSearch. OpenSearch retrieves this metric from the node's operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.

      API name: disk.avail

    • diskIndices

      @Nonnull public final AllocationRecord.Builder diskIndices(@Nullable String value)
      Disk space used by the node's shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.

      API name: disk.indices

    • diskPercent

      @Nonnull public final AllocationRecord.Builder diskPercent(@Nullable String value)
      Total percentage of disk space in use. Calculated as disk.used / disk.total.

      API name: disk.percent

    • diskTotal

      @Nonnull public final AllocationRecord.Builder diskTotal(@Nullable String value)
      Total disk space for the node, including in-use and available space.

      API name: disk.total

    • diskUsed

      @Nonnull public final AllocationRecord.Builder diskUsed(@Nullable String value)
      Total disk space in use. OpenSearch retrieves this metric from the node's operating system (OS). The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node's operating system; any other applications or files on the node. Unlike disk.indices, this metric does not double-count disk space for hard-linked files.

      API name: disk.used

    • host

      @Nonnull public final AllocationRecord.Builder host(@Nullable String value)
      Network host for the node. Set using the network.host setting.

      API name: host

    • ip

      @Nonnull public final AllocationRecord.Builder ip(@Nullable String value)
      IP address and port for the node.

      API name: ip

    • node

      @Nonnull public final AllocationRecord.Builder node(@Nullable String value)
      Name for the node. Set using the node.name setting.

      API name: node

    • shards

      @Nonnull public final AllocationRecord.Builder shards(@Nullable String value)
      Number of primary and replica shards assigned to the node.

      API name: shards

    • build

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