@azure-rest/health-deidentification package
Интерфейсы
Псевдонимы типа
| CancelJobParameters | |
| DeidentificationClient | |
| DeidentificationOperationType |
Псевдоним для DeidentificationOperationType |
| DeidentificationOperationTypeOutput |
Псевдоним для DeidentificationOperationTypeOutput |
| DeidentifyDocumentsParameters | |
| DeidentifyTextParameters | |
| DeleteJobParameters | |
| GetArrayType |
Вспомогательный тип для извлечения типа массива |
| GetJobParameters | |
| GetPage |
Тип настраиваемой функции, которая определяет, как получить страницу и ссылку на следующую. |
| ListJobDocumentsParameters | |
| ListJobsParameters | |
| OperationState |
Псевдоним для OperationState |
| OperationStateOutput |
Псевдоним для OperationStateOutput |
| PaginateReturn |
Вспомогательный тип для вывода типа страничных элементов из типа ответа этот тип создается на основе сведений swagger для x-ms-pageable специально в свойстве itemName, которое указывает свойство ответа, в котором находятся элементы страницы. Значение по умолчанию — |
| PhiCategoryOutput |
Псевдоним для PhiCategoryOutput |
Функции
Сведения о функции
default(string, TokenCredential, DeidentificationClientOptions)
Инициализация нового экземпляра DeidentificationClient
function default(endpointParam: string, credentials: TokenCredential, options?: DeidentificationClientOptions): DeidentificationClient
Параметры
- endpointParam
-
string
URL-адрес службы отмены идентификации.
- credentials
- TokenCredential
уникально идентификация учетных данных клиента
- options
- DeidentificationClientOptions
параметр для всех необязательных параметров
Возвращаемое значение
getLongRunningPoller<TResult>(Client, DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.
function getLongRunningPoller<TResult>(client: Client, initialResponse: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Параметры
- client
- Client
Клиент, используемый для отправки запроса, чтобы получить дополнительные страницы.
- initialResponse
-
DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse
Начальный ответ.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Параметры для задания состояния возобновления или настраиваемого интервала опроса.
Возвращаемое значение
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Объект опроса для проверки обновлений состояния операции и в конечном итоге получает окончательный ответ.
isUnexpected(GetJob200Response | GetJobDefaultResponse)
function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse)
function isUnexpected(response: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse)
function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(ListJobs200Response | ListJobsDefaultResponse)
function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(ListJobDocuments200Response | ListJobDocumentsDefaultResponse)
function isUnexpected(response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(CancelJob200Response | CancelJobDefaultResponse)
function isUnexpected(response: CancelJob200Response | CancelJobDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(DeidentifyText200Response | DeidentifyTextDefaultResponse)
function isUnexpected(response: DeidentifyText200Response | DeidentifyTextDefaultResponse): response
Параметры
Возвращаемое значение
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Параметры
- client
- Client
Клиент, используемый для отправки запросов на следующую страницу
- initialResponse
-
TResponse
Начальный ответ, содержащий следующую ссылку и текущую страницу элементов
- options
-
PagingOptions<TResponse>
Возвращаемое значение
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator для итерации элементов