-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
CancelJobOptions.cs
43 lines (36 loc) · 1.4 KB
/
CancelJobOptions.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
using System;
using System.Text.Json;
using Azure.Core;
namespace Azure.Communication.JobRouter
{
/// <summary>
/// Options for cancelling a job.
/// </summary>
public partial class CancelJobOptions
{
/// <summary> Initializes a new instance of CancelJobOptions. </summary>
internal CancelJobOptions()
{
}
/// <param name="jobId"> Id of a job. </param>
/// <exception cref="ArgumentNullException"> <paramref name="jobId"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="jobId"/> is an empty string, and was expected to be non-empty. </exception>
public CancelJobOptions(string jobId)
{
Argument.AssertNotNullOrEmpty(jobId, nameof(jobId));
JobId = jobId;
}
/// <summary>
/// Id of a job.
/// </summary>
public string JobId { get; }
/// <summary> Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set. </summary>
public string DispositionCode { get; set; }
/// <summary>
/// A note that will be appended to a job's Notes collection with the current timestamp.
/// </summary>
public string Note { get; set; }
}
}