Package co.elastic.clients.elasticsearch.ccr

Class ShardStats.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<ShardStats.Builder>
co.elastic.clients.elasticsearch.ccr.ShardStats.Builder
All Implemented Interfaces:
WithJson<ShardStats.Builder>, ObjectBuilder<ShardStats>
Enclosing class:
ShardStats
public static class ShardStats.Builder extends WithJsonObjectBuilderBase<ShardStats.Builder> implements ObjectBuilder<ShardStats>
Builder for ShardStats.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytesRead

      public final ShardStats.Builder bytesRead(long value)
      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 ShardStats.Builder failedReadRequests(long value)
      Required - The number of failed reads.

      API name: failed_read_requests

    • failedWriteRequests

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

      API name: failed_write_requests

    • fatalException

      public final ShardStats.Builder fatalException(@Nullable ErrorCause value)
      API name: fatal_exception

    • fatalException

      public final ShardStats.Builder fatalException(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)
      API name: fatal_exception

    • followerAliasesVersion

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

      API name: follower_aliases_version

    • followerGlobalCheckpoint

      public final ShardStats.Builder followerGlobalCheckpoint(long value)
      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 ShardStats.Builder followerIndex(String value)
      Required - The name of the follower index.

      API name: follower_index

    • followerMappingVersion

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

      API name: follower_mapping_version

    • followerMaxSeqNo

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

      API name: follower_max_seq_no

    • followerSettingsVersion

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

      API name: follower_settings_version

    • lastRequestedSeqNo

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

      API name: last_requested_seq_no

    • leaderGlobalCheckpoint

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

      API name: leader_global_checkpoint

    • leaderIndex

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

      API name: leader_index

    • leaderMaxSeqNo

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

      API name: leader_max_seq_no

    • operationsRead

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

      API name: operations_read

    • operationsWritten

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

      API name: operations_written

    • outstandingReadRequests

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

      API name: outstanding_read_requests

    • outstandingWriteRequests

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

      API name: outstanding_write_requests

    • readExceptions

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

      API name: read_exceptions

      Adds all elements of list to readExceptions.

    • readExceptions

      public final ShardStats.Builder readExceptions(ReadException value, ReadException... values)
      Required - An array of objects representing failed reads.

      API name: read_exceptions

      Adds one or more values to readExceptions.

    • readExceptions

      public final ShardStats.Builder readExceptions(Function<ReadException.Builder,ObjectBuilder<ReadException>> fn)
      Required - An array of objects representing failed reads.

      API name: read_exceptions

      Adds a value to readExceptions using a builder lambda.

    • remoteCluster

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

      API name: remote_cluster

    • shardId

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

      API name: shard_id

    • successfulReadRequests

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

      API name: successful_read_requests

    • successfulWriteRequests

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

      API name: successful_write_requests

    • timeSinceLastRead

      public final ShardStats.Builder timeSinceLastRead(@Nullable Time value)
      API name: time_since_last_read

    • timeSinceLastRead

      public final ShardStats.Builder timeSinceLastRead(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: time_since_last_read

    • timeSinceLastReadMillis

      public final ShardStats.Builder timeSinceLastReadMillis(long value)
      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

      public final ShardStats.Builder totalReadRemoteExecTime(@Nullable Time value)
      API name: total_read_remote_exec_time

    • totalReadRemoteExecTime

      public final ShardStats.Builder totalReadRemoteExecTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: total_read_remote_exec_time

    • totalReadRemoteExecTimeMillis

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

      API name: total_read_remote_exec_time_millis

    • totalReadTime

      public final ShardStats.Builder totalReadTime(@Nullable Time value)
      API name: total_read_time

    • totalReadTime

      public final ShardStats.Builder totalReadTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: total_read_time

    • totalReadTimeMillis

      public final ShardStats.Builder totalReadTimeMillis(long value)
      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

      public final ShardStats.Builder totalWriteTime(@Nullable Time value)
      API name: total_write_time

    • totalWriteTime

      public final ShardStats.Builder totalWriteTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: total_write_time

    • totalWriteTimeMillis

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

      API name: total_write_time_millis

    • writeBufferOperationCount

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

      API name: write_buffer_operation_count

    • writeBufferSizeInBytes

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

      API name: write_buffer_size_in_bytes

    • self

      protected ShardStats.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<ShardStats.Builder>

    • build

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