Interface ListExternalLocationsRequest

interface ListExternalLocationsRequest {
    includeBrowse?: boolean;
    includeUnbound?: boolean;
    maxResults?: number;
    pageToken?: string;
}

Properties

includeBrowse?: boolean

Whether to include external locations in the response for which the principal can only access selective metadata for

includeUnbound?: boolean

Whether to include external locations not bound to the workspace. Effective only if the user has permission to update the location–workspace binding.

maxResults?: number

Maximum number of external locations to return. If not set, all the external locations are returned (not recommended).

when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
when set to 0, the page length is set to a server configured value (recommended);
when set to a value less than 0, an invalid parameter error is returned;

pageToken?: string

Opaque pagination token to go to next page based on previous query.