/* * --------------------------------------------------------- * Copyright(C) Microsoft Corporation. All rights reserved. * --------------------------------------------------------- * * --------------------------------------------------------- * Generated file, DO NOT EDIT * --------------------------------------------------------- * * See following wiki page for instructions on how to regenerate: * https://aka.ms/azure-devops-client-generation * * Configuration file: * distributedtask\client\webapi\clientgeneratorconfigs\genclient.json */ using System; using System.Collections.Generic; using System.Collections.Specialized; using System.ComponentModel; using System.Globalization; using System.IO; using System.IO.Compression; using System.Linq; using System.Net.Http; using System.Net.Http.Headers; using System.Net.Http.Formatting; using System.Threading; using System.Threading.Tasks; using GitHub.Services.Common; using GitHub.Services.WebApi; namespace GitHub.DistributedTask.WebApi { [ResourceArea(TaskResourceIds.AreaId)] public abstract class TaskAgentHttpClientBase : VssHttpClientBase { public TaskAgentHttpClientBase(Uri baseUrl, VssCredentials credentials) : base(baseUrl, credentials) { } public TaskAgentHttpClientBase(Uri baseUrl, VssCredentials credentials, VssHttpRequestSettings settings) : base(baseUrl, credentials, settings) { } public TaskAgentHttpClientBase(Uri baseUrl, VssCredentials credentials, params DelegatingHandler[] handlers) : base(baseUrl, credentials, handlers) { } public TaskAgentHttpClientBase(Uri baseUrl, VssCredentials credentials, VssHttpRequestSettings settings, params DelegatingHandler[] handlers) : base(baseUrl, credentials, settings, handlers) { } public TaskAgentHttpClientBase(Uri baseUrl, HttpMessageHandler pipeline, bool disposeHandler) : base(baseUrl, pipeline, disposeHandler) { } /// /// [Preview API] Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, [configure an agent](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) using the agent download package. /// /// The agent pool in which to add the agent /// Details about the agent being added /// /// The cancellation token to cancel operation. public virtual Task AddAgentAsync( int poolId, TaskAgent agent, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("POST"); Guid locationId = new Guid("e298ef32-5878-4cab-993c-043836571f42"); object routeValues = new { poolId = poolId }; HttpContent content = new ObjectContent(agent, new VssJsonMediaTypeFormatter(true)); return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 2), userState: userState, cancellationToken: cancellationToken, content: content); } /// /// [Preview API] Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization. /// /// The pool ID to remove the agent from /// The agent ID to remove /// /// The cancellation token to cancel operation. public virtual async Task DeleteAgentAsync( int poolId, ulong agentId, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("DELETE"); Guid locationId = new Guid("e298ef32-5878-4cab-993c-043836571f42"); object routeValues = new { poolId = poolId, agentId = agentId }; using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 2), userState: userState, cancellationToken: cancellationToken).ConfigureAwait(false)) { return; } } /// /// [Preview API] Get information about an agent. /// /// The agent pool containing the agent /// The agent ID to get information about /// Whether to include the agent's capabilities in the response /// Whether to include details about the agent's current work /// Whether to include details about the agents' most recent completed work /// Filter which custom properties will be returned /// /// The cancellation token to cancel operation. public virtual Task GetAgentAsync( int poolId, int agentId, bool? includeCapabilities = null, bool? includeAssignedRequest = null, bool? includeLastCompletedRequest = null, IEnumerable propertyFilters = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("e298ef32-5878-4cab-993c-043836571f42"); object routeValues = new { poolId = poolId, agentId = agentId }; List> queryParams = new List>(); if (includeCapabilities != null) { queryParams.Add("includeCapabilities", includeCapabilities.Value.ToString()); } if (includeAssignedRequest != null) { queryParams.Add("includeAssignedRequest", includeAssignedRequest.Value.ToString()); } if (includeLastCompletedRequest != null) { queryParams.Add("includeLastCompletedRequest", includeLastCompletedRequest.Value.ToString()); } if (propertyFilters != null && propertyFilters.Any()) { queryParams.Add("propertyFilters", string.Join(",", propertyFilters)); } return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 2), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] Get a list of agents. /// /// The agent pool containing the agents /// Filter on agent name /// Whether to include the agents' capabilities in the response /// Whether to include details about the agents' current work /// Whether to include details about the agents' most recent completed work /// Filter which custom properties will be returned /// Filter by demands the agents can satisfy /// /// The cancellation token to cancel operation. public virtual Task> GetAgentsAsync( int poolId, string agentName = null, bool? includeCapabilities = null, bool? includeAssignedRequest = null, bool? includeLastCompletedRequest = null, IEnumerable propertyFilters = null, IEnumerable demands = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("e298ef32-5878-4cab-993c-043836571f42"); object routeValues = new { poolId = poolId }; List> queryParams = new List>(); if (agentName != null) { queryParams.Add("agentName", agentName); } if (includeCapabilities != null) { queryParams.Add("includeCapabilities", includeCapabilities.Value.ToString()); } if (includeAssignedRequest != null) { queryParams.Add("includeAssignedRequest", includeAssignedRequest.Value.ToString()); } if (includeLastCompletedRequest != null) { queryParams.Add("includeLastCompletedRequest", includeLastCompletedRequest.Value.ToString()); } if (propertyFilters != null && propertyFilters.Any()) { queryParams.Add("propertyFilters", string.Join(",", propertyFilters)); } if (demands != null && demands.Any()) { queryParams.Add("demands", string.Join(",", demands)); } return SendAsync>( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 2), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] Replace an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove and reconfigure an agent from your organization. /// /// The agent pool to use /// The agent to replace /// Updated details about the replacing agent /// /// The cancellation token to cancel operation. public virtual Task ReplaceAgentAsync( int poolId, ulong agentId, TaskAgent agent, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("PUT"); Guid locationId = new Guid("e298ef32-5878-4cab-993c-043836571f42"); object routeValues = new { poolId = poolId, agentId = agentId }; HttpContent content = new ObjectContent(agent, new VssJsonMediaTypeFormatter(true)); return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 2), userState: userState, cancellationToken: cancellationToken, content: content); } /// /// [Preview API] Update agent details. /// /// The agent pool to use /// The agent to update /// Updated details about the agent /// /// The cancellation token to cancel operation. public virtual Task UpdateAgentAsync( int poolId, int agentId, TaskAgent agent, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("PATCH"); Guid locationId = new Guid("e298ef32-5878-4cab-993c-043836571f42"); object routeValues = new { poolId = poolId, agentId = agentId }; HttpContent content = new ObjectContent(agent, new VssJsonMediaTypeFormatter(true)); return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 2), userState: userState, cancellationToken: cancellationToken, content: content); } /// /// [Preview API] /// /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task DeleteAgentRequestAsync( int poolId, long requestId, Guid lockToken, TaskResult? result = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("DELETE"); Guid locationId = new Guid("fc825784-c92a-4299-9221-998a02d1b54f"); object routeValues = new { poolId = poolId, requestId = requestId }; List> queryParams = new List>(); queryParams.Add("lockToken", lockToken.ToString()); if (result != null) { queryParams.Add("result", result.Value.ToString()); } using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken).ConfigureAwait(false)) { return; } } /// /// [Preview API] /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task GetAgentRequestAsync( int poolId, long requestId, bool? includeStatus = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("fc825784-c92a-4299-9221-998a02d1b54f"); object routeValues = new { poolId = poolId, requestId = requestId }; List> queryParams = new List>(); if (includeStatus != null) { queryParams.Add("includeStatus", includeStatus.Value.ToString()); } return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] /// /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task UpdateAgentRequestAsync( int poolId, long requestId, Guid lockToken, TaskAgentJobRequest request, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("PATCH"); Guid locationId = new Guid("fc825784-c92a-4299-9221-998a02d1b54f"); object routeValues = new { poolId = poolId, requestId = requestId }; HttpContent content = new ObjectContent(request, new VssJsonMediaTypeFormatter(true)); List> queryParams = new List>(); queryParams.Add("lockToken", lockToken.ToString()); return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken, content: content); } /// /// [Preview API] /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task DeleteMessageAsync( int poolId, long messageId, Guid sessionId, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("DELETE"); Guid locationId = new Guid("c3a054f6-7a8a-49c0-944e-3a8e5d7adfd7"); object routeValues = new { poolId = poolId, messageId = messageId }; List> queryParams = new List>(); queryParams.Add("sessionId", sessionId.ToString()); using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken).ConfigureAwait(false)) { return; } } /// /// [Preview API] /// /// /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task GetMessageAsync( int poolId, Guid sessionId, long? lastMessageId = null, TaskAgentStatus? status = null, string runnerVersion = null, string os = null, string architecture = null, bool? disableUpdate = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("c3a054f6-7a8a-49c0-944e-3a8e5d7adfd7"); object routeValues = new { poolId = poolId }; List> queryParams = new List>(); queryParams.Add("sessionId", sessionId.ToString()); if (lastMessageId != null) { queryParams.Add("lastMessageId", lastMessageId.Value.ToString(CultureInfo.InvariantCulture)); } if (status != null) { queryParams.Add("status", status.Value.ToString()); } if (runnerVersion != null) { queryParams.Add("runnerVersion", runnerVersion); } if (os != null) { queryParams.Add("os", os); } if (architecture != null) { queryParams.Add("architecture", architecture); } if (disableUpdate != null) { queryParams.Add("disableUpdate", disableUpdate.Value.ToString().ToLower()); } return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(6.0, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task RefreshAgentAsync( int poolId, int agentId, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("POST"); Guid locationId = new Guid("c3a054f6-7a8a-49c0-944e-3a8e5d7adfd7"); object routeValues = new { poolId = poolId }; List> queryParams = new List>(); queryParams.Add("agentId", agentId.ToString(CultureInfo.InvariantCulture)); using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken).ConfigureAwait(false)) { return; } } /// /// [Preview API] /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task RefreshAgentsAsync( int poolId, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("POST"); Guid locationId = new Guid("c3a054f6-7a8a-49c0-944e-3a8e5d7adfd7"); object routeValues = new { poolId = poolId }; using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), userState: userState, cancellationToken: cancellationToken).ConfigureAwait(false)) { return; } } /// /// [Preview API] /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task SendMessageAsync( int poolId, long requestId, TaskAgentMessage message, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("POST"); Guid locationId = new Guid("c3a054f6-7a8a-49c0-944e-3a8e5d7adfd7"); object routeValues = new { poolId = poolId }; HttpContent content = new ObjectContent(message, new VssJsonMediaTypeFormatter(true)); List> queryParams = new List>(); queryParams.Add("requestId", requestId.ToString(CultureInfo.InvariantCulture)); using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken, content: content).ConfigureAwait(false)) { return; } } /// /// [Preview API] /// /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task GetPackageAsync( string packageType, string platform, string version, bool? includeToken = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("8ffcd551-079c-493a-9c02-54346299d144"); object routeValues = new { packageType = packageType, platform = platform, version = version }; List> queryParams = new List>(); if (includeToken != null) { queryParams.Add("includeToken", includeToken.Value.ToString()); } return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 2), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] /// /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task> GetPackagesAsync( string packageType, string platform = null, int? top = null, bool? includeToken = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("8ffcd551-079c-493a-9c02-54346299d144"); object routeValues = new { packageType = packageType, platform = platform }; List> queryParams = new List>(); if (top != null) { queryParams.Add("$top", top.Value.ToString(CultureInfo.InvariantCulture)); } if (includeToken != null) { queryParams.Add("includeToken", includeToken.Value.ToString()); } return SendAsync>( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 2), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] Get a list of agent pools. /// /// Filter by name /// Filter by agent pool properties (comma-separated) /// Filter by pool type /// Filter by whether the calling user has use or manage permissions /// /// The cancellation token to cancel operation. public virtual Task> GetAgentPoolsAsync( string poolName = null, IEnumerable properties = null, TaskAgentPoolType? poolType = null, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("GET"); Guid locationId = new Guid("a8c47e17-4d56-4a56-92bb-de7ea7dc65be"); List> queryParams = new List>(); if (poolName != null) { queryParams.Add("poolName", poolName); } if (properties != null && properties.Any()) { queryParams.Add("properties", string.Join(",", properties)); } if (poolType != null) { queryParams.Add("poolType", poolType.Value.ToString()); } return SendAsync>( httpMethod, locationId, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } /// /// [Preview API] /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task CreateAgentSessionAsync( int poolId, TaskAgentSession session, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("POST"); Guid locationId = new Guid("134e239e-2df3-4794-a6f6-24f1f19ec8dc"); object routeValues = new { poolId = poolId }; HttpContent content = new ObjectContent(session, new VssJsonMediaTypeFormatter(true)); return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), userState: userState, cancellationToken: cancellationToken, content: content); } /// /// [Preview API] /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task DeleteAgentSessionAsync( int poolId, Guid sessionId, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("DELETE"); Guid locationId = new Guid("134e239e-2df3-4794-a6f6-24f1f19ec8dc"); object routeValues = new { poolId = poolId, sessionId = sessionId }; using (HttpResponseMessage response = await SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), userState: userState, cancellationToken: cancellationToken).ConfigureAwait(false)) { return; } } /// /// [Preview API] /// /// /// /// /// /// /// The cancellation token to cancel operation. [EditorBrowsable(EditorBrowsableState.Never)] public virtual Task UpdateAgentUpdateStateAsync( int poolId, ulong agentId, string currentState, string updateTrace, object userState = null, CancellationToken cancellationToken = default) { HttpMethod httpMethod = new HttpMethod("PUT"); Guid locationId = new Guid("8cc1b02b-ae49-4516-b5ad-4f9b29967c30"); object routeValues = new { poolId = poolId, agentId = agentId }; List> queryParams = new List>(); queryParams.Add("currentState", currentState); queryParams.Add("updateTrace", updateTrace); return SendAsync( httpMethod, locationId, routeValues: routeValues, version: new ApiResourceVersion(5.1, 1), queryParameters: queryParams, userState: userState, cancellationToken: cancellationToken); } } }