/* 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
* 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.
*/
// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗
// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝
// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗
// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝
// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗
// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝
// -----------------------------------------------
//
// This file is automatically generated
// Please do not edit these files manually
// Run the following in the root of the repos:
//
// *NIX : ./build.sh codegen
// Windows : build.bat codegen
//
// -----------------------------------------------
// ReSharper disable RedundantUsingDirective
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Linq.Expressions;
// ReSharper disable once CheckNamespace
namespace OpenSearch.Net.Specification.TasksApi
{
///Request options for Cancel https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/
public class CancelTasksRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => false;
///A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
public string[] Actions
{
get => Q("actions");
set => Q("actions", value);
}
///
/// A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're
/// connecting to, leave empty to get information from all nodes
///
public string[] Nodes
{
get => Q("nodes");
set => Q("nodes", value);
}
///Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
public string ParentTaskId
{
get => Q("parent_task_id");
set => Q("parent_task_id", value);
}
///Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
public bool? WaitForCompletion
{
get => Q("wait_for_completion");
set => Q("wait_for_completion", value);
}
}
///Request options for GetTask https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/
public class GetTaskRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///Explicit operation timeout
public TimeSpan Timeout
{
get => Q("timeout");
set => Q("timeout", value);
}
///Wait for the matching tasks to complete (default: false)
public bool? WaitForCompletion
{
get => Q("wait_for_completion");
set => Q("wait_for_completion", value);
}
}
///Request options for List https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/
public class ListTasksRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///A comma-separated list of actions that should be returned. Leave empty to return all.
public string[] Actions
{
get => Q("actions");
set => Q("actions", value);
}
///Return detailed task information (default: false)
public bool? Detailed
{
get => Q("detailed");
set => Q("detailed", value);
}
///Group tasks by nodes or parent/child relationships
public GroupBy? GroupBy
{
get => Q("group_by");
set => Q("group_by", value);
}
///
/// A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're
/// connecting to, leave empty to get information from all nodes
///
public string[] Nodes
{
get => Q("nodes");
set => Q("nodes", value);
}
///Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
public string ParentTaskId
{
get => Q("parent_task_id");
set => Q("parent_task_id", value);
}
///Explicit operation timeout
public TimeSpan Timeout
{
get => Q("timeout");
set => Q("timeout", value);
}
///Wait for the matching tasks to complete (default: false)
public bool? WaitForCompletion
{
get => Q("wait_for_completion");
set => Q("wait_for_completion", value);
}
}
}