specification/cat/aliases/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 { IndexName } from '@_types/common'

export class AliasesRecord {
  /**
   * alias name
   * @aliases a
   */
  'alias'?: string
  /**
   * index alias points to
   * @aliases i,idx
   */
  'index'?: IndexName
  /**
   * filter
   * @aliases f,fi
   */
  'filter'?: string
  /**
   * index routing
   * @aliases ri,routingIndex
   */
  'routing.index'?: string
  /**
   * search routing
   * @aliases rs,routingSearch
   */
  'routing.search'?: string
  /**
   * write index
   * @aliases w,isWriteIndex
   */
  'is_write_index'?: string
}