AgentsListOptionalParams interface

Parametri facoltativi.

Extends

Proprietà

after

Cursore da usare nell'impaginazione. after è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, che terminano con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.

before

Cursore da usare nell'impaginazione. before è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.

kind

Filtra gli agenti per tipo. Se non viene fornito, tutti gli agenti vengono restituiti.

limit

Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.

order

Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per l'ordine decrescente.

Proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

after

Cursore da usare nell'impaginazione. after è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, che terminano con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.

after?: string

Valore della proprietà

string

before

Cursore da usare nell'impaginazione. before è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.

before?: string

Valore della proprietà

string

kind

Filtra gli agenti per tipo. Se non viene fornito, tutti gli agenti vengono restituiti.

kind?: AgentKind

Valore della proprietà

limit

Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.

limit?: number

Valore della proprietà

number

order

Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per l'ordine decrescente.

order?: PageOrder

Valore della proprietà

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

Ereditato da OperationOptions.abortSignal

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

Ereditato da OperationOptions.onResponse

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

Ereditato da OperationOptions.requestOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

Ereditato da OperationOptions.tracingOptions