JobRouterClient.CloseJob Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

CloseJob(CloseJobOptions, CancellationToken)

Closes a completed job.

CloseJob(String, String, RequestContent, RequestContext)

[Protocol Method] Closes a completed job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler Azure.Communication.JobRouter.JobRouterClient.CloseJob(System.String,System.String,Azure.Communication.JobRouter.CloseJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.

CloseJob(CloseJobOptions, CancellationToken)

Source:

JobRouterClient.cs

Closes a completed job.

public virtual Azure.Response CloseJob (Azure.Communication.JobRouter.CloseJobOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member CloseJob : Azure.Communication.JobRouter.CloseJobOptions * System.Threading.CancellationToken -> Azure.Response
override this.CloseJob : Azure.Communication.JobRouter.CloseJobOptions * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function CloseJob (options As CloseJobOptions, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

options

CloseJobOptions

Options for closing job.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

ArgumentNullException

options is null.

CloseJob(String, String, RequestContent, RequestContext)

Source:

JobRouterClient.cs

[Protocol Method] Closes a completed job.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler Azure.Communication.JobRouter.JobRouterClient.CloseJob(System.String,System.String,Azure.Communication.JobRouter.CloseJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response CloseJob (string jobId, string assignmentId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CloseJob : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CloseJob : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function CloseJob (jobId As String, assignmentId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

jobId

String

Id of a job.

assignmentId

String

Id of a job assignment.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

jobId or assignmentId is null.

ArgumentException

jobId or assignmentId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.