@opensearch-project/opensearch/api/list/indices.d.ts

The official OpenSearch client for Node.js

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 */

/*
 * This file was generated from the OpenSearch API Spec. Do NOT edit it
 * manually. If you want to make changes, either update the spec or
 * modify the API generator.
 */

import { ApiResponse } from '../../lib/Transport'
import * as Cat_Indices from '../_types/cat.indices'
import * as Common from '../_types/_common'
import * as Global from '../_types/_global'

export interface List_Indices_Request extends Global.Params {
  bytes?: Common.ByteUnit;
  cluster_manager_timeout?: Common.Duration;
  expand_wildcards?: Common.ExpandWildcards;
  format?: string;
  h?: string[];
  health?: Common.HealthStatus;
  help?: boolean;
  include_unloaded_segments?: boolean;
  index?: Common.Indices;
  local?: boolean;
  master_timeout?: Common.Duration;
  next_token?: undefined | string;
  pri?: boolean;
  s?: string[];
  size?: number;
  sort?: 'asc' | 'desc';
  time?: Common.TimeUnit;
  v?: boolean;
}

export interface List_Indices_Response extends ApiResponse {
  body: List_Indices_ResponseBody;
}

export type List_Indices_ResponseBody = {
  indices?: Cat_Indices.IndicesRecord[];
  next_token?: undefined | string;
}