Share via

@azure-rest/health-deidentification package

Interfaces

CancelJob
CancelJob200Headers
CancelJob200Response

The request has succeeded.
CancelJobDefaultHeaders
CancelJobDefaultResponse
CancelJobHeaderParam
CancelJobHeaders
DeidentificationClientOptions

The optional parameters for the client
DeidentificationContent

Request body for de-identification operation.
DeidentificationCustomizationOptions

Customizations options to override default service behaviors for synchronous usage.
DeidentificationDocumentDetailsOutput

Details of a single document in a job.
DeidentificationDocumentLocationOutput

Location of a document.
DeidentificationJob

A job containing a batch of documents to de-identify.
DeidentificationJobCustomizationOptions

Customizations options to override default service behaviors for job usage.
DeidentificationJobCustomizationOptionsOutput

Customizations options to override default service behaviors for job usage.
DeidentificationJobOutput

A job containing a batch of documents to de-identify.
DeidentificationJobSummary

Summary metrics of a job.
DeidentificationJobSummaryOutput

Summary metrics of a job.
DeidentificationResultOutput

Response body for de-identification operation.
DeidentifyDocuments200Headers
DeidentifyDocuments200Response

The request has succeeded.
DeidentifyDocuments201Headers
DeidentifyDocuments201Response

The request has succeeded and a new resource has been created as a result.
DeidentifyDocumentsBodyParam
DeidentifyDocumentsDefaultHeaders
DeidentifyDocumentsDefaultResponse
DeidentifyDocumentsHeaderParam
DeidentifyDocumentsHeaders
DeidentifyDocumentsLogicalResponse

The final response for long-running deidentifyDocuments operation
DeidentifyText
DeidentifyText200Headers
DeidentifyText200Response

The request has succeeded.
DeidentifyTextBodyParam
DeidentifyTextDefaultHeaders
DeidentifyTextDefaultResponse
DeidentifyTextHeaderParam
DeidentifyTextHeaders
DeleteJob204Headers
DeleteJob204Response

There is no content to send for this request, but the headers may be useful.
DeleteJobDefaultHeaders
DeleteJobDefaultResponse
DeleteJobHeaderParam
DeleteJobHeaders
GetJob
GetJob200Headers
GetJob200Response

The request has succeeded.
GetJobDefaultHeaders
GetJobDefaultResponse
GetJobHeaderParam
GetJobHeaders
ListJobDocuments
ListJobDocuments200Headers
ListJobDocuments200Response

The request has succeeded.
ListJobDocumentsDefaultHeaders
ListJobDocumentsDefaultResponse
ListJobDocumentsHeaderParam
ListJobDocumentsHeaders
ListJobDocumentsQueryParam
ListJobDocumentsQueryParamProperties
ListJobs
ListJobs200Headers
ListJobs200Response

The request has succeeded.
ListJobsDefaultHeaders
ListJobsDefaultResponse
ListJobsHeaderParam
ListJobsHeaders
ListJobsQueryParam
ListJobsQueryParamProperties
PageSettings

An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.
PagedDeidentificationDocumentDetailsOutput

Paged collection of DeidentificationDocumentDetails items
PagedDeidentificationJobOutput

Paged collection of DeidentificationJob items
PagingOptions

Options for the paging helper
PhiEntityOutput

PHI Entity tag in the input.
PhiTaggerResultOutput

Result of the "Tag" operation.
Routes
SimplePollerLike

A simple poller that can be used to poll a long running operation.
SourceStorageLocation

Storage location.
SourceStorageLocationOutput

Storage location.
StringIndexOutput

String index encoding model.
TargetStorageLocation

Storage location.
TargetStorageLocationOutput

Storage location.

Type Aliases

CancelJobParameters
DeidentificationClient
DeidentificationOperationType

Alias for DeidentificationOperationType
DeidentificationOperationTypeOutput

Alias for DeidentificationOperationTypeOutput
DeidentifyDocumentsParameters
DeidentifyTextParameters
DeleteJobParameters
GetArrayType

Helper type to extract the type of an array
GetJobParameters
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.
ListJobDocumentsParameters
ListJobsParameters
OperationState

Alias for OperationState
OperationStateOutput

Alias for OperationStateOutput
PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
PhiCategoryOutput

Alias for PhiCategoryOutput

Functions

default(string, TokenCredential, DeidentificationClientOptions)

Initialize a new instance of DeidentificationClient
getLongRunningPoller<TResult>(Client, DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.
isUnexpected(GetJob200Response | GetJobDefaultResponse)
isUnexpected(DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse)
isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse)
isUnexpected(ListJobs200Response | ListJobsDefaultResponse)
isUnexpected(ListJobDocuments200Response | ListJobDocumentsDefaultResponse)
isUnexpected(CancelJob200Response | CancelJobDefaultResponse)
isUnexpected(DeidentifyText200Response | DeidentifyTextDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, TokenCredential, DeidentificationClientOptions)

Initialize a new instance of DeidentificationClient

function default(endpointParam: string, credentials: TokenCredential, options?: DeidentificationClientOptions): DeidentificationClient

Parameters

endpointParam

string

Url of your De-identification Service.

credentials
TokenCredential

uniquely identify client credential

options
DeidentificationClientOptions

the parameter for all optional parameters

Returns

DeidentificationClient

getLongRunningPoller<TResult>(Client, DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client

Client to use for sending the request to get additional pages.

initialResponse

DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • A poller object to poll for operation state updates and eventually get the final response.

isUnexpected(GetJob200Response | GetJobDefaultResponse) 

function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response

Parameters

response

GetJob200Response | GetJobDefaultResponse

Returns

response

isUnexpected(DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse) 

function isUnexpected(response: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse): response

Parameters

response

DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse

Returns

response

isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse) 

function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response

Parameters

response

DeleteJob204Response | DeleteJobDefaultResponse

Returns

response

isUnexpected(ListJobs200Response | ListJobsDefaultResponse) 

function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response

Parameters

response

ListJobs200Response | ListJobsDefaultResponse

Returns

response

isUnexpected(ListJobDocuments200Response | ListJobDocumentsDefaultResponse) 

function isUnexpected(response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse): response

Parameters

response

ListJobDocuments200Response | ListJobDocumentsDefaultResponse

Returns

response

isUnexpected(CancelJob200Response | CancelJobDefaultResponse) 

function isUnexpected(response: CancelJob200Response | CancelJobDefaultResponse): response

Parameters

response

CancelJob200Response | CancelJobDefaultResponse

Returns

response

isUnexpected(DeidentifyText200Response | DeidentifyTextDefaultResponse) 

function isUnexpected(response: DeidentifyText200Response | DeidentifyTextDefaultResponse): response

Parameters

response

DeidentifyText200Response | DeidentifyTextDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator to iterate the elements