AgentsListOptimizationCandidatesOptionalParams interface

Parametry opcjonalne.

Rozszerzenie

Właściwości

after

Candidate-ID kursorem identyfikującym ostatni element z poprzedniej strony.

before

Candidate-ID kursorem wskazującym pierwszy element z następnej strony.

expand

Lista kluczy rozszerzania oddzielonych przecinkami. Przejdź mutations do zapełnienia pól mutacji value ; pomiń do otrzymywania elementów mutacji zawierających tylko type. Dodatkowe klucze do rozszerzenia mogą zostać dodane w przyszłych podglądach.

limit

Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.

order

Sortuj kolejność według znacznika czasu kandydata started_at .

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

after

Candidate-ID kursorem identyfikującym ostatni element z poprzedniej strony.

after?: string

Wartość właściwości

string

before

Candidate-ID kursorem wskazującym pierwszy element z następnej strony.

before?: string

Wartość właściwości

string

expand

Lista kluczy rozszerzania oddzielonych przecinkami. Przejdź mutations do zapełnienia pól mutacji value ; pomiń do otrzymywania elementów mutacji zawierających tylko type. Dodatkowe klucze do rozszerzenia mogą zostać dodane w przyszłych podglądach.

expand?: "mutations"[]

Wartość właściwości

"mutations"[]

limit

Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.

limit?: number

Wartość właściwości

number

order

Sortuj kolejność według znacznika czasu kandydata started_at .

order?: PageOrder

Wartość właściwości

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

dziedziczone z OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

dziedziczone z OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

dziedziczone z OperationOptions.requestOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

dziedziczone z OperationOptions.tracingOptions