specification/cluster/stats/ClusterStatsResponse.ts

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { NodesResponseBase } from '@nodes/_types/NodesResponseBase'
import { HealthStatus, Name, Uuid } from '@_types/common'
import { long } from '@_types/Numeric'
import { CCSStats, ClusterIndices, ClusterNodes } from './types'

export class StatsResponseBase extends NodesResponseBase {
  /**
   * Name of the cluster, based on the cluster name setting.
   */
  cluster_name: Name
  /**
   * Unique identifier for the cluster.
   */
  cluster_uuid: Uuid
  /**
   * Contains statistics about indices with shards assigned to selected nodes.
   */
  indices: ClusterIndices
  /**
   * Contains statistics about nodes selected by the request’s node filters.
   * @doc_id cluster-nodes
   */
  nodes: ClusterNodes
  /**
   * Health status of the cluster, based on the state of its primary and replica shards.
   */
  status: HealthStatus
  /**
   * Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.
   */
  timestamp: long
  /**
   * Cross-cluster stats
   */
  ccs: CCSStats
}

export class Response {
  /** @codegen_name stats */
  body: StatsResponseBase
}