Type Alias ListPoolsRequest

ListPoolsRequest: {
    clusterId: string;
    name?: string;
    orderBy?: ListPoolsRequestOrderBy;
    page?: number;
    pageSize?: number;
    region?: Region;
    status?: PoolStatus;
}

Type declaration

  • clusterId: string

    ID of the cluster whose pools will be listed.

  • Optionalname?: string

    Name to filter on, only pools containing this substring in their name will be returned.

  • OptionalorderBy?: ListPoolsRequestOrderBy

    Sort order of returned pools.

  • Optionalpage?: number

    Page number for the returned pools.

  • OptionalpageSize?: number

    Maximum number of pools per page.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionalstatus?: PoolStatus

    Status to filter on, only pools with this status will be returned.

Settings