Package org.opensearch.client.opensearch.indices.recovery

Class ShardRecovery

java.lang.Object
org.opensearch.client.opensearch.indices.recovery.ShardRecovery
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ShardRecovery.Builder,ShardRecovery>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class ShardRecovery extends Object implements PlainJsonSerializable, ToCopyableBuilder<ShardRecovery.Builder,ShardRecovery>
The recovery status of a shard.

  • Field Details

  • Method Details

    • of

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

    • id

      public final int id()
      Required - The shard ID.

      API name: id

    • index

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

    • primary

      public final boolean primary()
      Required - Whether this is a primary shard.

      API name: primary

    • source

      @Nonnull public final RecoveryOrigin source()
      Required - API name: source

    • stage

      @Nonnull public final String stage()
      Required - The current recovery stage.

      API name: stage

    • start

      @Nullable public final RecoveryStartStatus start()
      API name: start

    • startTime

      @Nullable public final String startTime()
      API name: start_time

    • startTimeInMillis

      public final long startTimeInMillis()
      Required - API name: start_time_in_millis

    • stopTime

      @Nullable public final String stopTime()
      API name: stop_time

    • stopTimeInMillis

      @Nullable public final Long stopTimeInMillis()
      API name: stop_time_in_millis

    • target

      @Nonnull public final RecoveryOrigin target()
      Required - API name: target

    • totalTime

      @Nullable public final Time totalTime()
      API name: total_time

    • totalTimeInMillis

      public final long totalTimeInMillis()
      Required - API name: total_time_in_millis

    • translog

      @Nonnull public final TranslogStatus translog()
      Required - API name: translog

    • type

      @Nonnull public final String type()
      Required - The type of recovery operation.

      API name: type

    • verifyIndex

      @Nonnull public final VerifyIndex verifyIndex()
      Required - API name: verify_index

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

    • builder

      @Nonnull public static ShardRecovery.Builder builder()

    • setupShardRecoveryDeserializer

      protected static void setupShardRecoveryDeserializer(ObjectDeserializer<ShardRecovery.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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