tgstation-server 6.12.0
The /tg/station 13 server suite
Loading...
Searching...
No Matches
JobsClient.cs
Go to the documentation of this file.
1using System;
2using System.Collections.Generic;
3using System.Threading;
4using System.Threading.Tasks;
5
9
11{
45}
Common base of entities with IDs.
Definition EntityId.cs:7
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
Metadata about a server instance.
Definition Instance.cs:9
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
Routes to a server actions.
Definition Routes.cs:9
static string SetID(string route, long id)
Apply an id postfix to a route .
static string ListRoute(string route)
Get the /List postfix for a route .
const string Jobs
The jobs controller.
Definition Routes.cs:103
ValueTask Delete(string route, CancellationToken cancellationToken)
Run an HTTP DELETE request.A ValueTask representing the running operation.
ValueTask< List< JobResponse > > ListActive(PaginationSettings? paginationSettings, CancellationToken cancellationToken)
List the active JobResponses in the Instance.A ValueTask<TResult> resulting in a List<T> of the activ...
ValueTask Cancel(JobResponse job, CancellationToken cancellationToken)
Cancels a job .A ValueTask representing the running operation.
JobsClient(IApiClient apiClient, Instance instance)
Initializes a new instance of the JobsClient class.
Definition JobsClient.cs:25
readonly Instance instance
The Instance for the JobsClient.
Definition JobsClient.cs:18
ValueTask< List< JobResponse > > List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)
List the JobResponses in the Instance.A ValueTask<TResult> resulting in a List<T> of the JobResponse ...
ValueTask< JobResponse > GetId(EntityId job, CancellationToken cancellationToken)
Get a job .A ValueTask<TResult> resulting in the JobResponse.
Client that deals with getting paginated results.
Settings for a paginated request.
Web interface for the API.
Definition IApiClient.cs:17