types.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 { ByteSize } from '@_types/common'
import { Host, Ip } from '@_types/Networking'
import { Percentage } from '@_types/Numeric'

export class AllocationRecord {
  /**
   * number of shards on node
   * @aliases s
   */
  shards?: string
  /**
   * disk used by ES indices
   * @aliases di,diskIndices
   */
  'disk.indices'?: ByteSize | null
  /**
   * disk used (total, not just ES)
   * @aliases du,diskUsed
   */
  'disk.used'?: ByteSize | null
  /**
   * disk available
   * @aliases da,diskAvail
   */
  'disk.avail'?: ByteSize | null
  /**
   * total capacity of all volumes
   * @aliases dt,diskTotal
   */
  'disk.total'?: ByteSize | null
  /**
   * percent disk used
   * @aliases dp,diskPercent
   */
  'disk.percent'?: Percentage | null
  /**
   * host of node
   * @aliases h
   */
  host?: Host | null
  /**
   * ip of node
   */
  ip?: Ip | null
  /**
   * name of node
   * @aliases n
   */
  node?: string
}