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


ListRunStepsOptions interface

Сведения, используемые для перечисления шагов выполнения.

Extends

Свойства

after

Курсор для использования при разбиении на страницы. after — это идентификатор объекта, определяющий ваше место в списке. Например, если вы выполняете запрос списка и получаете 100 объектов, заканчивающиеся obj_foo, последующий вызов может включать after=obj_foo для получения следующей страницы списка.

before

Курсор для использования при разбиении на страницы. before — это идентификатор объекта, определяющий ваше место в списке. Например, если вы выполняете запрос списка и получаете 100 объектов, заканчивающиеся obj_foo, последующий вызов может включать параметр before=obj_foo для получения предыдущей страницы списка.

limit

Ограничение на количество возвращаемых объектов. Ограничение может быть в диапазоне от 1 до 100, а значение по умолчанию — 20.

order

Сортировка по created_at метке времени объектов. asc для возрастающего порядка и desc для порядка убывания.

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

abortSignal

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

onResponse

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

requestOptions

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

tracingOptions

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

Сведения о свойстве

after

Курсор для использования при разбиении на страницы. after — это идентификатор объекта, определяющий ваше место в списке. Например, если вы выполняете запрос списка и получаете 100 объектов, заканчивающиеся obj_foo, последующий вызов может включать after=obj_foo для получения следующей страницы списка.

after?: string

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

string

before

Курсор для использования при разбиении на страницы. before — это идентификатор объекта, определяющий ваше место в списке. Например, если вы выполняете запрос списка и получаете 100 объектов, заканчивающиеся obj_foo, последующий вызов может включать параметр before=obj_foo для получения предыдущей страницы списка.

before?: string

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

string

limit

Ограничение на количество возвращаемых объектов. Ограничение может быть в диапазоне от 1 до 100, а значение по умолчанию — 20.

limit?: number

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

number

order

Сортировка по created_at метке времени объектов. asc для возрастающего порядка и desc для порядка убывания.

order?: string

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

string

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

abortSignal

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

abortSignal?: AbortSignalLike

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

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

onResponse

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

onResponse?: RawResponseCallback

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

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

requestOptions

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

requestOptions?: OperationRequestOptions

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

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

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