AgentOptimizationJobs Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The AgentOptimizationJobs sub-client.
public class AgentOptimizationJobstype AgentOptimizationJobs = classPublic Class AgentOptimizationJobs- Inheritance
-
AgentOptimizationJobs
Constructors
| Name | Description |
|---|---|
| AgentOptimizationJobs() |
Initializes a new instance of AgentOptimizationJobs for mocking. |
Properties
| Name | Description |
|---|---|
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
| Name | Description |
|---|---|
| Cancel(String, CancellationToken) |
Request cancellation. Idempotent on terminal states. |
| CancelAsync(String, CancellationToken) |
Request cancellation. Idempotent on terminal states. |
| Create(OptimizationJobInputs, String, CancellationToken) |
Create an optimization job. Returns 201 with the queued job. Honours |
| CreateAsync(OptimizationJobInputs, String, CancellationToken) |
Create an optimization job. Returns 201 with the queued job. Honours |
| Delete(String, Nullable<Boolean>, CancellationToken) |
Delete the job and its candidate artifacts. Cancels first if non-terminal. |
| DeleteAsync(String, Nullable<Boolean>, CancellationToken) |
Delete the job and its candidate artifacts. Cancels first if non-terminal. |
| Get(String, CancellationToken) |
Get an optimization job by id. Returns 202 while in progress, 200 when terminal. |
| GetAll(Nullable<Int32>, Nullable<AgentListOrder>, String, String, Nullable<JobStatus>, String, CancellationToken) |
List optimization jobs. Supports cursor pagination and optional status / agent_name filters. |
| GetAllAsync(Nullable<Int32>, Nullable<AgentListOrder>, String, String, Nullable<JobStatus>, String, CancellationToken) |
List optimization jobs. Supports cursor pagination and optional status / agent_name filters. |
| GetAsync(String, CancellationToken) |
Get an optimization job by id. Returns 202 while in progress, 200 when terminal. |
| GetCandidate(String, String, CancellationToken) |
Get a single candidate's metadata, manifest, and promotion info. |
| GetCandidateAsync(String, String, CancellationToken) |
Get a single candidate's metadata, manifest, and promotion info. |
| GetCandidateConfig(String, String, CancellationToken) |
Get the candidate's deploy config JSON. Used to compose |
| GetCandidateConfigAsync(String, String, CancellationToken) |
Get the candidate's deploy config JSON. Used to compose |
| GetCandidateFile(String, String, String, CancellationToken) |
Stream a specific file from the candidate's blob directory. |
| GetCandidateFileAsync(String, String, String, CancellationToken) |
Stream a specific file from the candidate's blob directory. |
| GetCandidateResults(String, String, CancellationToken) |
Get full per-task evaluation results for a candidate. |
| GetCandidateResultsAsync(String, String, CancellationToken) |
Get full per-task evaluation results for a candidate. |
| GetCandidates(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken) |
List candidates produced by a job. |
| GetCandidatesAsync(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken) |
List candidates produced by a job. |
| PromoteCandidate(String, String, PromoteCandidateRequest, CancellationToken) |
Promotes a candidate, recording the deployment timestamp and target agent version. |
| PromoteCandidateAsync(String, String, PromoteCandidateRequest, CancellationToken) |
Promotes a candidate, recording the deployment timestamp and target agent version. |
