DeidentificationClient.GetJobDocuments Method
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.
Overloads
| GetJobDocuments(String, Nullable<Int32>, String, RequestContext) |
[Protocol Method] List processed documents within a job.
|
| GetJobDocuments(String, Nullable<Int32>, String, CancellationToken) |
List processed documents within a job. |
GetJobDocuments(String, Nullable<Int32>, String, 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 GetJobDocuments(String, Nullable<Int32>, String, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Pageable<BinaryData> GetJobDocuments (string name, int? maxpagesize, string continuationToken, Azure.RequestContext context);abstract member GetJobDocuments : string * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetJobDocuments : string * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>Public Overridable Function GetJobDocuments (name As String, maxpagesize As Nullable(Of Integer), continuationToken As String, context As RequestContext) As Pageable(Of BinaryData)Parameters
- name
- String
The name of a job.
- continuationToken
- String
Token to continue a previous query.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The Pageable<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
name is null.
name is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call GetJobDocuments and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
foreach (BinaryData item in client.GetJobDocuments("<name>", null, null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("input").GetProperty("path").ToString());
Console.WriteLine(result.GetProperty("input").GetProperty("etag").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
This sample shows how to call GetJobDocuments with all parameters and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
foreach (BinaryData item in client.GetJobDocuments("<name>", 1234, "<continuationToken>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("input").GetProperty("path").ToString());
Console.WriteLine(result.GetProperty("input").GetProperty("etag").ToString());
Console.WriteLine(result.GetProperty("output").GetProperty("path").ToString());
Console.WriteLine(result.GetProperty("output").GetProperty("etag").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
Applies to
GetJobDocuments(String, Nullable<Int32>, String, CancellationToken)
List processed documents within a job.
public virtual Azure.Pageable<Azure.Health.Deidentification.DocumentDetails> GetJobDocuments (string name, int? maxpagesize = default, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetJobDocuments : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Health.Deidentification.DocumentDetails>
override this.GetJobDocuments : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Health.Deidentification.DocumentDetails>Public Overridable Function GetJobDocuments (name As String, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentDetails)Parameters
- name
- String
The name of a job.
- continuationToken
- String
Token to continue a previous query.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
name is null.
name is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call GetJobDocuments.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
foreach (DocumentDetails item in client.GetJobDocuments("<name>"))
{
}
This sample shows how to call GetJobDocuments with all parameters.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
foreach (DocumentDetails item in client.GetJobDocuments("<name>", maxpagesize: 1234, continuationToken: "<continuationToken>"))
{
}
Remarks
Resource list operation template.
Applies to
Azure SDK for .NET