/// <summary>
/// Cancels or terminates the specified jobs.
/// </summary>
/// <remarks>
/// Required permissions: Jobs.Edit.
/// </remarks>
/// <param name='stopJobsParameters'>
/// JobIds - The ids for the jobs to be canceled or terminated;
/// Strategy - States whether a job should be soft stopped or killed
/// immediately.
/// </param>
/// <param name='customHeaders'>
/// Headers that will be added to request.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
/// <exception cref="HttpOperationException">
/// Thrown when the operation returned an invalid status code
/// </exception>
/// <exception cref="ValidationException">
/// Thrown when a required parameter is null
/// </exception>
/// <exception cref="System.ArgumentNullException">
/// Thrown when a required parameter is null
/// </exception>
/// <return>
/// A response object containing the response body and response headers.
/// </return>
public async Task <HttpOperationResponse> StopJobsWithHttpMessagesAsync(StopJobsParameters stopJobsParameters, Dictionary <string, List <string> > customHeaders = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
if (stopJobsParameters == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "stopJobsParameters");
}
if (stopJobsParameters != null)
{
stopJobsParameters.Validate();
}
// Tracing
bool _shouldTrace = ServiceClientTracing.IsEnabled;
string _invocationId = null;
if (_shouldTrace)
{
_invocationId = ServiceClientTracing.NextInvocationId.ToString();
Dictionary <string, object> tracingParameters = new Dictionary <string, object>();
tracingParameters.Add("stopJobsParameters", stopJobsParameters);
tracingParameters.Add("cancellationToken", cancellationToken);
ServiceClientTracing.Enter(_invocationId, this, "StopJobs", tracingParameters);
}
// Construct URL
var _baseUrl = Client.BaseUri.AbsoluteUri;
var _url = new System.Uri(new System.Uri(_baseUrl + (_baseUrl.EndsWith("/") ? "" : "/")), "odata/Jobs/UiPath.Server.Configuration.OData.StopJobs").ToString();
// Create HTTP transport objects
var _httpRequest = new HttpRequestMessage();
HttpResponseMessage _httpResponse = null;
_httpRequest.Method = new HttpMethod("POST");
_httpRequest.RequestUri = new System.Uri(_url);
// Set Headers
if (customHeaders != null)
{
foreach (var _header in customHeaders)
{
if (_httpRequest.Headers.Contains(_header.Key))
{
_httpRequest.Headers.Remove(_header.Key);
}
_httpRequest.Headers.TryAddWithoutValidation(_header.Key, _header.Value);
}
}
// Serialize Request
string _requestContent = null;
if (stopJobsParameters != null)
{
_requestContent = Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(stopJobsParameters, Client.SerializationSettings);
_httpRequest.Content = new StringContent(_requestContent, System.Text.Encoding.UTF8);
_httpRequest.Content.Headers.ContentType = System.Net.Http.Headers.MediaTypeHeaderValue.Parse("application/json; charset=utf-8");
}
// Set Credentials
if (Client.Credentials != null)
{
cancellationToken.ThrowIfCancellationRequested();
await Client.Credentials.ProcessHttpRequestAsync(_httpRequest, cancellationToken).ConfigureAwait(false);
}
// Send Request
if (_shouldTrace)
{
ServiceClientTracing.SendRequest(_invocationId, _httpRequest);
}
cancellationToken.ThrowIfCancellationRequested();
_httpResponse = await Client.HttpClient.SendAsync(_httpRequest, cancellationToken).ConfigureAwait(false);
if (_shouldTrace)
{
ServiceClientTracing.ReceiveResponse(_invocationId, _httpResponse);
}
HttpStatusCode _statusCode = _httpResponse.StatusCode;
cancellationToken.ThrowIfCancellationRequested();
string _responseContent = null;
if ((int)_statusCode != 200)
{
var ex = new HttpOperationException(string.Format("Operation returned an invalid status code '{0}'", _statusCode));
if (_httpResponse.Content != null)
{
_responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false);
}
else
{
_responseContent = string.Empty;
}
ex.Request = new HttpRequestMessageWrapper(_httpRequest, _requestContent);
ex.Response = new HttpResponseMessageWrapper(_httpResponse, _responseContent);
if (_shouldTrace)
{
ServiceClientTracing.Error(_invocationId, ex);
}
_httpRequest.Dispose();
if (_httpResponse != null)
{
_httpResponse.Dispose();
}
throw ex;
}
// Create Result
var _result = new HttpOperationResponse();
_result.Request = _httpRequest;
_result.Response = _httpResponse;
if (_shouldTrace)
{
ServiceClientTracing.Exit(_invocationId, _result);
}
return(_result);
}
/// <summary>
/// Cancels or terminates the specified jobs.
/// </summary>
/// <remarks>
/// Required permissions: Jobs.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='stopJobsParameters'>
/// JobIds - The ids for the jobs to be canceled or terminated;
/// Strategy - States whether a job should be soft stopped or killed
/// immediately.
/// </param>
public static void StopJobs(this IJobs operations, StopJobsParameters stopJobsParameters)
{
operations.StopJobsAsync(stopJobsParameters).GetAwaiter().GetResult();
}
/// <summary>
/// Cancels or terminates the specified jobs.
/// </summary>
/// <remarks>
/// Required permissions: Jobs.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='stopJobsParameters'>
/// JobIds - The ids for the jobs to be canceled or terminated;
/// Strategy - States whether a job should be soft stopped or killed
/// immediately.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task StopJobsAsync(this IJobs operations, StopJobsParameters stopJobsParameters, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
(await operations.StopJobsWithHttpMessagesAsync(stopJobsParameters, null, cancellationToken).ConfigureAwait(false)).Dispose();
}
/// <summary>
/// Cancels or terminates the specified jobs.
/// </summary>
/// <remarks>
/// Required permissions: Jobs.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='stopJobsParameters'>
/// JobIds - The ids for the jobs to be canceled or terminated;
/// Strategy - States whether a job should be soft stopped or killed
/// immediately.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static void StopJobs(this IJobs operations, StopJobsParameters stopJobsParameters, long?xUIPATHOrganizationUnitId = default(long?))
{
operations.StopJobsAsync(stopJobsParameters, xUIPATHOrganizationUnitId).GetAwaiter().GetResult();
}