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


BeginComposeDocumentModelOptions interface

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

Extends

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

abortSignal

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

description

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

onProgress

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

onResponse

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

requestOptions

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

resumeFrom

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

serializerOptions

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

tags

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

tracingOptions

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

updateIntervalInMs

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

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

abortSignal

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

abortSignal?: AbortSignalLike

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

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

description

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

description?: string

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

string

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

onProgress

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

onProgress?: (state: DocumentModelOperationState) => void

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

(state: DocumentModelOperationState) => void

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

onResponse

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

onResponse?: RawResponseCallback

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

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

requestOptions

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

requestOptions?: OperationRequestOptions

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

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

resumeFrom

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

resumeFrom?: string

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

string

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

serializerOptions

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

serializerOptions?: SerializerOptions

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

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

tags

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

tags?: Record<string, string>

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

Record<string, string>

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

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

updateIntervalInMs

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

updateIntervalInMs?: number

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

number

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