DeidentificationClient.GetJobDocumentsAsync Method

Definition

Namespace:

Azure.Health.Deidentification

Assembly:

Azure.Health.Deidentification.dll

Package:

Azure.Health.Deidentification v1.0.0

Overloads

Name	Description
GetJobDocumentsAsync(String, Nullable<Int32>, RequestContext)	[Protocol Method] List processed documents within a job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetJobDocumentsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetJobDocumentsAsync(String, Nullable<Int32>, CancellationToken)	List processed documents within a job.

GetJobDocumentsAsync(String, Nullable<Int32>, RequestContext)

Source:

DeidentificationClient.cs

[Protocol Method] List processed documents within a job.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetJobDocumentsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.AsyncPageable<BinaryData> GetJobDocumentsAsync(string jobName, int? maxpagesize, Azure.RequestContext context);

abstract member GetJobDocumentsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetJobDocumentsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetJobDocumentsAsync (jobName As String, maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)

Parameters

jobName

String

The name of a job.

maxpagesize

Nullable<Int32>

The maximum number of result items per page.

context

RequestContext

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

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

jobName is null.

ArgumentException

jobName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

GetJobDocumentsAsync(String, Nullable<Int32>, CancellationToken)

Source:

DeidentificationClient.cs

List processed documents within a job.

public virtual Azure.AsyncPageable<Azure.Health.Deidentification.DeidentificationDocumentDetails> GetJobDocumentsAsync(string jobName, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetJobDocumentsAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Health.Deidentification.DeidentificationDocumentDetails>
override this.GetJobDocumentsAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Health.Deidentification.DeidentificationDocumentDetails>

Public Overridable Function GetJobDocumentsAsync (jobName As String, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DeidentificationDocumentDetails)

Parameters

jobName

String

The name of a job.

maxpagesize

Nullable<Int32>

The maximum number of result items per page.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<DeidentificationDocumentDetails>

Exceptions

ArgumentNullException

jobName is null.

ArgumentException

jobName is an empty string, and was expected to be non-empty.

Remarks

The most basic operation.