CancelJobOptions 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.
Request payload for cancelling a job.
public class CancelJobOptions
public class CancelJobOptions : System.ClientModel.Primitives.IJsonModel<Azure.Communication.JobRouter.CancelJobOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Communication.JobRouter.CancelJobOptions>
type CancelJobOptions = class
type CancelJobOptions = class
interface IJsonModel<CancelJobOptions>
interface IPersistableModel<CancelJobOptions>
Public Class CancelJobOptions
Public Class CancelJobOptions
Implements IJsonModel(Of CancelJobOptions), IPersistableModel(Of CancelJobOptions)
- Inheritance
-
CancelJobOptions
- Implements
Constructors
CancelJobOptions(String) |
Public constructor. |
Properties
DispositionCode |
Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set. |
JobId |
Id of a job. |
Note |
A note that will be appended to a job's Notes collection with the current timestamp. |
Explicit Interface Implementations
IJsonModel<CancelJobOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<CancelJobOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<CancelJobOptions>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<CancelJobOptions>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<CancelJobOptions>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |