Package org.opensearch.client.opensearch.cat

Class SegmentReplicationRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.cat.CatRequestBase
org.opensearch.client.opensearch.cat.SegmentReplicationRequest
All Implemented Interfaces:
ToCopyableBuilder<SegmentReplicationRequest.Builder,SegmentReplicationRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class SegmentReplicationRequest extends CatRequestBase implements ToCopyableBuilder<SegmentReplicationRequest.Builder,SegmentReplicationRequest>
Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.

  • Field Details

  • Method Details

    • of

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

    • activeOnly

      @Nullable public final Boolean activeOnly()
      When true, the response only includes ongoing segment replication events.

      API name: active_only

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the _all string or when no indexes have been specified.

      API name: allow_no_indices

    • bytes

      @Nullable public final Bytes bytes()
      The units used to display byte values.

      API name: bytes

    • completedOnly

      @Nullable public final Boolean completedOnly()
      When true, the response only includes the last-completed segment replication events.

      API name: completed_only

    • detailed

      @Nullable public final Boolean detailed()
      When true, the response includes additional metrics for each stage of a segment replication event.

      API name: detailed

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

      API name: expand_wildcards

    • ignoreThrottled

      @Nullable public final Boolean ignoreThrottled()
      Whether specified concrete, expanded, or aliased indexes should be ignored when throttled.

      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether the specified concrete indexes should be ignored when missing or closed.

      API name: ignore_unavailable

    • index

      @Nonnull public final List<String> index()
      A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

    • shards

      @Nonnull public final List<String> shards()
      A comma-separated list of shards to display.

      API name: shards

    • time

      @Nullable public final TimeUnit time()
      Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

      API name: time

    • timeout

      @Nullable public final Time timeout()
      The operation timeout.

      API name: timeout

    • toBuilder

      @Nonnull public SegmentReplicationRequest.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<SegmentReplicationRequest.Builder,SegmentReplicationRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static SegmentReplicationRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class CatRequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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