Interface SandboxListRequest

Request for SandboxClient.list.

interface SandboxListRequest {
    callOptions?: CallOptions;
    externalId?: string;
    pageSize?: number;
    query?: string;
    statuses?: SandboxStatus[];
}

Index

Properties

callOptions? externalId? pageSize? query? statuses?

Properties

`Optional`callOptions

callOptions?: CallOptions

`Optional`externalId

externalId?: string

Only the sandbox with this external identifier. Cannot be combined with statuses.

`Optional`pageSize

pageSize?: number

How many sandboxes to fetch per underlying request.

`Optional`query

query?: string

Searches sandbox names and labels.

`Optional`statuses

statuses?: SandboxStatus[]

Only sandboxes with one of these statuses. Cannot be combined with externalId.