Package co.elastic.clients.elasticsearch.ccr

Class ShardStats

java.lang.Object
co.elastic.clients.elasticsearch.ccr.ShardStats
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ShardStats extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • bytesRead

      public final long bytesRead()
      Required - The total of transferred bytes read from the leader. This is only an estimate and does not account for compression if enabled.

      API name: bytes_read

    • failedReadRequests

      public final long failedReadRequests()
      Required - The number of failed reads.

      API name: failed_read_requests

    • failedWriteRequests

      public final long failedWriteRequests()
      Required - The number of failed bulk write requests on the follower.

      API name: failed_write_requests

    • fatalException

      @Nullable public final ErrorCause fatalException()
      API name: fatal_exception

    • followerAliasesVersion

      public final long followerAliasesVersion()
      Required - The index aliases version the follower is synced up to.

      API name: follower_aliases_version

    • followerGlobalCheckpoint

      public final long followerGlobalCheckpoint()
      Required - The current global checkpoint on the follower. The difference between the leader_global_checkpoint and the follower_global_checkpoint is an indication of how much the follower is lagging the leader.

      API name: follower_global_checkpoint

    • followerIndex

      public final String followerIndex()
      Required - The name of the follower index.

      API name: follower_index

    • followerMappingVersion

      public final long followerMappingVersion()
      Required - The mapping version the follower is synced up to.

      API name: follower_mapping_version

    • followerMaxSeqNo

      public final long followerMaxSeqNo()
      Required - The current maximum sequence number on the follower.

      API name: follower_max_seq_no

    • followerSettingsVersion

      public final long followerSettingsVersion()
      Required - The index settings version the follower is synced up to.

      API name: follower_settings_version

    • lastRequestedSeqNo

      public final long lastRequestedSeqNo()
      Required - The starting sequence number of the last batch of operations requested from the leader.

      API name: last_requested_seq_no

    • leaderGlobalCheckpoint

      public final long leaderGlobalCheckpoint()
      Required - The current global checkpoint on the leader known to the follower task.

      API name: leader_global_checkpoint

    • leaderIndex

      public final String leaderIndex()
      Required - The name of the index in the leader cluster being followed.

      API name: leader_index

    • leaderMaxSeqNo

      public final long leaderMaxSeqNo()
      Required - The current maximum sequence number on the leader known to the follower task.

      API name: leader_max_seq_no

    • operationsRead

      public final long operationsRead()
      Required - The total number of operations read from the leader.

      API name: operations_read

    • operationsWritten

      public final long operationsWritten()
      Required - The number of operations written on the follower.

      API name: operations_written

    • outstandingReadRequests

      public final int outstandingReadRequests()
      Required - The number of active read requests from the follower.

      API name: outstanding_read_requests

    • outstandingWriteRequests

      public final int outstandingWriteRequests()
      Required - The number of active bulk write requests on the follower.

      API name: outstanding_write_requests

    • readExceptions

      public final List<ReadException> readExceptions()
      Required - An array of objects representing failed reads.

      API name: read_exceptions

    • remoteCluster

      public final String remoteCluster()
      Required - The remote cluster containing the leader index.

      API name: remote_cluster

    • shardId

      public final int shardId()
      Required - The numerical shard ID, with values from 0 to one less than the number of replicas.

      API name: shard_id

    • successfulReadRequests

      public final long successfulReadRequests()
      Required - The number of successful fetches.

      API name: successful_read_requests

    • successfulWriteRequests

      public final long successfulWriteRequests()
      Required - The number of bulk write requests run on the follower.

      API name: successful_write_requests

    • timeSinceLastRead

      @Nullable public final Time timeSinceLastRead()
      API name: time_since_last_read

    • timeSinceLastReadMillis

      public final long timeSinceLastReadMillis()
      Required - The number of milliseconds since a read request was sent to the leader. When the follower is caught up to the leader, this number will increase up to the configured read_poll_timeout at which point another read request will be sent to the leader.

      API name: time_since_last_read_millis

    • totalReadRemoteExecTime

      @Nullable public final Time totalReadRemoteExecTime()
      API name: total_read_remote_exec_time

    • totalReadRemoteExecTimeMillis

      public final long totalReadRemoteExecTimeMillis()
      Required - The total time reads spent running on the remote cluster.

      API name: total_read_remote_exec_time_millis

    • totalReadTime

      @Nullable public final Time totalReadTime()
      API name: total_read_time

    • totalReadTimeMillis

      public final long totalReadTimeMillis()
      Required - The total time reads were outstanding, measured from the time a read was sent to the leader to the time a reply was returned to the follower.

      API name: total_read_time_millis

    • totalWriteTime

      @Nullable public final Time totalWriteTime()
      API name: total_write_time

    • totalWriteTimeMillis

      public final long totalWriteTimeMillis()
      Required - The total time spent writing on the follower.

      API name: total_write_time_millis

    • writeBufferOperationCount

      public final long writeBufferOperationCount()
      Required - The number of write operations queued on the follower.

      API name: write_buffer_operation_count

    • writeBufferSizeInBytes

      public final String writeBufferSizeInBytes()
      Required - The total number of bytes of operations currently queued for writing.

      API name: write_buffer_size_in_bytes

    • 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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupShardStatsDeserializer

      protected static void setupShardStatsDeserializer(ObjectDeserializer<ShardStats.Builder> op)