Package org.opensearch.client.opensearch._types

Class NodeShard

java.lang.Object
org.opensearch.client.opensearch._types.NodeShard
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<NodeShard.Builder,NodeShard>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class NodeShard extends Object implements PlainJsonSerializable, ToCopyableBuilder<NodeShard.Builder,NodeShard>
The information about a shard on a node.

  • Field Details

  • Method Details

    • of

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

    • allocationId

      @Nonnull public final Map<String,String> allocationId()
      API name: allocation_id

    • index

      @Nonnull public final String index()
      Required - API name: index

    • node

      @Nullable public final String node()
      API name: node

    • primary

      public final boolean primary()
      Required - API name: primary

    • recoverySource

      @Nonnull public final Map<String,String> recoverySource()
      The recovery source information for this shard.

      API name: recovery_source

    • relocatingNode

      @Nullable public final String relocatingNode()
      API name: relocating_node

    • searchOnly

      @Nullable public final Boolean searchOnly()
      Indicates if this shard is configured for search operations only

      API name: searchOnly

    • shard

      public final int shard()
      Required - API name: shard

    • state

      @Nonnull public final ShardRoutingState state()
      Required - API name: state

    • unassignedInfo

      @Nullable public final UnassignedInformation unassignedInfo()
      API name: unassigned_info

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

    • builder

      @Nonnull public static NodeShard.Builder builder()

    • setupNodeShardDeserializer

      protected static void setupNodeShardDeserializer(ObjectDeserializer<NodeShard.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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