Поделиться через


CreateDocumentModelOptions interface

Параметры для операции создания модели.

Extends

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.

description

Текстовое описание модели (может быть любым текстом).

onProgress

Необязательный начальный обработчик хода выполнения, который будет вызываться при обновлении состояния опроса. Этот обработчик будет вызываться один раз сразу после инициализации состояния опроса.

onResponse

Функция, вызываемая при каждом получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

resumeFrom

Сериализованное состояние опрашителя. Если он указан, операция опроса будет возобновлена из заданного состояния, а не запущена, как если бы это была новая операция.

serializerOptions

Параметры для переопределения поведения сериализации или десериализации.

tags

Дополнительные пользовательские пары "ключ-значение" для связывания с моделью в качестве постоянных метаданных.

tracingOptions

Параметры, используемые при включенной трассировке.

updateIntervalInMs

Время ожидания (в миллисекундах) между последующими запросами, связанными с той же операцией.

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

Наследуется отPollerOptions.abortSignal

description

Текстовое описание модели (может быть любым текстом).

description?: string

Значение свойства

string

Наследуется отCommonModelCreationOptions.description

onProgress

Необязательный начальный обработчик хода выполнения, который будет вызываться при обновлении состояния опроса. Этот обработчик будет вызываться один раз сразу после инициализации состояния опроса.

onProgress?: (state: DocumentModelOperationState) => void

Значение свойства

(state: DocumentModelOperationState) => void

Наследуется отPollerOptions.onProgress

onResponse

Функция, вызываемая при каждом получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

Значение свойства

Наследуется отPollerOptions.onResponse

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

Значение свойства

Наследуется отPollerOptions.requestOptions

resumeFrom

Сериализованное состояние опрашителя. Если он указан, операция опроса будет возобновлена из заданного состояния, а не запущена, как если бы это была новая операция.

resumeFrom?: string

Значение свойства

string

Наследуется отPollerOptions.resumeFrom

serializerOptions

Параметры для переопределения поведения сериализации или десериализации.

serializerOptions?: SerializerOptions

Значение свойства

Наследуется отPollerOptions.serializerOptions

tags

Дополнительные пользовательские пары "ключ-значение" для связывания с моделью в качестве постоянных метаданных.

tags?: Record<string, string>

Значение свойства

Record<string, string>

Наследуется отCommonModelCreationOptions.tags

tracingOptions

Параметры, используемые при включенной трассировке.

tracingOptions?: OperationTracingOptions

Значение свойства

Наследуется отPollerOptions.tracingOptions

updateIntervalInMs

Время ожидания (в миллисекундах) между последующими запросами, связанными с той же операцией.

updateIntervalInMs?: number

Значение свойства

number

Наследуется отPollerOptions.updateIntervalInMs