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

Class CCSUsageStats.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • total

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

      API name: total

    • success

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

      API name: success

    • skipped

      public final CCSUsageStats.Builder skipped(int value)
      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 CCSUsageStats.Builder took(CCSUsageTimeValue value)
      Required - Statistics about the time taken to execute cross-cluster search requests.

      API name: took

    • took

      public final CCSUsageStats.Builder took(Function<CCSUsageTimeValue.Builder,ObjectBuilder<CCSUsageTimeValue>> fn)
      Required - Statistics about the time taken to execute cross-cluster search requests.

      API name: took

    • tookMrtTrue

      public final CCSUsageStats.Builder tookMrtTrue(@Nullable CCSUsageTimeValue value)
      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

    • tookMrtTrue

      public final CCSUsageStats.Builder tookMrtTrue(Function<CCSUsageTimeValue.Builder,ObjectBuilder<CCSUsageTimeValue>> fn)
      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

      public final CCSUsageStats.Builder tookMrtFalse(@Nullable CCSUsageTimeValue value)
      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

    • tookMrtFalse

      public final CCSUsageStats.Builder tookMrtFalse(Function<CCSUsageTimeValue.Builder,ObjectBuilder<CCSUsageTimeValue>> fn)
      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 CCSUsageStats.Builder remotesPerSearchMax(int value)
      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 CCSUsageStats.Builder remotesPerSearchAvg(double value)
      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 CCSUsageStats.Builder failureReasons(Map<String,Integer> map)
      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

      Adds all entries of map to failureReasons.

    • failureReasons

      public final CCSUsageStats.Builder failureReasons(String key, Integer value)
      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

      Adds an entry to failureReasons.

    • features

      public final CCSUsageStats.Builder features(Map<String,Integer> map)
      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

      Adds all entries of map to features.

    • features

      public final CCSUsageStats.Builder features(String key, Integer value)
      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

      Adds an entry to features.

    • clients

      public final CCSUsageStats.Builder clients(Map<String,Integer> map)
      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

      Adds all entries of map to clients.

    • clients

      public final CCSUsageStats.Builder clients(String key, Integer value)
      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

      Adds an entry to clients.

    • clusters

      public final CCSUsageStats.Builder clusters(Map<String,CCSUsageClusterStats> map)
      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

      Adds all entries of map to clusters.

    • clusters

      public final CCSUsageStats.Builder clusters(String key, CCSUsageClusterStats value)
      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

      Adds an entry to clusters.

    • clusters

      public final CCSUsageStats.Builder clusters(String key, Function<CCSUsageClusterStats.Builder,ObjectBuilder<CCSUsageClusterStats>> fn)
      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

      Adds an entry to clusters using a builder lambda.

    • self

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

    • build

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