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

Class AllocationRecord

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

  • Field Details

  • Method Details

    • of

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

    • diskAvail

      @Nullable public final String diskAvail()
      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

      @Nullable public final String diskIndices()
      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

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

      API name: disk.percent

    • diskTotal

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

      API name: disk.total

    • diskUsed

      @Nullable public final String diskUsed()
      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

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

      API name: host

    • ip

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

      API name: ip

    • node

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

      API name: node

    • shards

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

      API name: shards

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

    • builder

      @Nonnull public static AllocationRecord.Builder builder()

    • setupAllocationRecordDeserializer

      protected static void setupAllocationRecordDeserializer(ObjectDeserializer<AllocationRecord.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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