@opensearch-project/opensearch/api/tasks/cancel.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 Common from '../_types/_common'
import * as Global from '../_types/_global'
import * as Tasks_Common from '../_types/tasks._common'

export interface Tasks_Cancel_Request extends Global.Params {
  actions?: Common.StringOrStringArray;
  nodes?: string[];
  parent_task_id?: string;
  task_id?: Common.TaskId;
  wait_for_completion?: boolean;
}

export interface Tasks_Cancel_Response extends ApiResponse {
  body: Tasks_Cancel_ResponseBody;
}

export type Tasks_Cancel_ResponseBody = Tasks_Common.TaskListResponseBase