Type Alias ListClustersRequest

ListClustersRequest: {
    name?: string;
    orderBy?: K8s.v1.ListClustersRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    privateNetworkId?: string;
    projectId?: string;
    region?: Region;
    status?: K8s.v1.ClusterStatus;
    type?: string;
}

Type declaration

  • Optionalname?: string

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

  • OptionalorderBy?: K8s.v1.ListClustersRequestOrderBy

    Sort order of returned clusters.

  • OptionalorganizationId?: string

    Organization ID on which to filter the returned clusters.

  • Optionalpage?: number

    Page number to return for clusters, from the paginated results.

  • OptionalpageSize?: number

    Maximum number of clusters per page.

  • OptionalprivateNetworkId?: string

    Private Network ID to filter on, only clusters within this Private Network will be returned.

  • OptionalprojectId?: string

    Project ID on which to filter the returned clusters.

  • Optionalregion?: Region

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

  • Optionalstatus?: K8s.v1.ClusterStatus

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

  • Optionaltype?: string

    Type to filter on, only clusters with this type will be returned.

Settings