Package co.elastic.clients.elasticsearch.cluster.stats

Class CCSUsageStats

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

  • Field Details

  • Method Details

    • of

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

    • total

      public final int total()
      Required - The total number of cross-cluster search requests that have been executed by the cluster.

      API name: total

    • success

      public final int success()
      Required - The total number of cross-cluster search requests that have been successfully executed by the cluster.

      API name: success

    • skipped

      public final int skipped()
      Required - The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.

      API name: skipped

    • took

      public final CCSUsageTimeValue took()
      Required - Statistics about the time taken to execute cross-cluster search requests.

      API name: took

    • tookMrtTrue

      @Nullable public final CCSUsageTimeValue tookMrtTrue()
      Statistics about the time taken to execute cross-cluster search requests for which the ccs_minimize_roundtrips setting was set to true.

      API name: took_mrt_true

    • tookMrtFalse

      @Nullable public final CCSUsageTimeValue tookMrtFalse()
      Statistics about the time taken to execute cross-cluster search requests for which the ccs_minimize_roundtrips setting was set to false.

      API name: took_mrt_false

    • remotesPerSearchMax

      public final int remotesPerSearchMax()
      Required - The maximum number of remote clusters that were queried in a single cross-cluster search request.

      API name: remotes_per_search_max

    • remotesPerSearchAvg

      public final double remotesPerSearchAvg()
      Required - The average number of remote clusters that were queried in a single cross-cluster search request.

      API name: remotes_per_search_avg

    • failureReasons

      public final Map<String,Integer> failureReasons()
      Required - Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.

      API name: failure_reasons

    • features

      public final Map<String,Integer> features()
      Required - The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).

      API name: features

    • clients

      public final Map<String,Integer> clients()
      Required - Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.

      API name: clients

    • clusters

      public final Map<String,CCSUsageClusterStats> clusters()
      Required - Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).

      API name: clusters

    • 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

    • setupCCSUsageStatsDeserializer

      protected static void setupCCSUsageStatsDeserializer(ObjectDeserializer<CCSUsageStats.Builder> op)