AgentsListOptimizationCandidatesOptionalParams interface

Optionale Parameter.

Extends

Eigenschaften

after

Candidate-ID Cursor identifiziert das letzte Element von der vorherigen Seite.

before

Candidate-ID Cursor identifiziert das erste Element auf der folgenden Seite.

expand

Komma-separierte Liste der Expand-Tasten. Pass, mutations um Mutationsfelder value zu füllen; weglassen, um Mutationselemente zu erhalten, die nur type. enthalten. Weitere Erweiterungstasten können in zukünftigen Vorschauen hinzugefügt werden.

limit

Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.

order

Sortiere die Reihenfolge nach dem Zeitstempel des Kandidaten started_at .

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

after

Candidate-ID Cursor identifiziert das letzte Element von der vorherigen Seite.

after?: string

Eigenschaftswert

string

before

Candidate-ID Cursor identifiziert das erste Element auf der folgenden Seite.

before?: string

Eigenschaftswert

string

expand

Komma-separierte Liste der Expand-Tasten. Pass, mutations um Mutationsfelder value zu füllen; weglassen, um Mutationselemente zu erhalten, die nur type. enthalten. Weitere Erweiterungstasten können in zukünftigen Vorschauen hinzugefügt werden.

expand?: "mutations"[]

Eigenschaftswert

"mutations"[]

limit

Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.

limit?: number

Eigenschaftswert

number

order

Sortiere die Reihenfolge nach dem Zeitstempel des Kandidaten started_at .

order?: PageOrder

Eigenschaftswert

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

von OperationOptions.abortSignal geerbt

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

von OperationOptions.onResponse geerbt

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

Von OperationOptions.requestOptions geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

von OperationOptions.tracingOptions geerbt