Interface ListNetworksOptions
interface ListNetworksOptions {
name?: string;
scope?: string;
owner?: string;
domain?: string;
parentId?: string;
ids?: Iterable<string, any, any>;
page?: number;
pageSize?: number;
timeout?: number;
}
name?: string;
scope?: string;
owner?: string;
domain?: string;
parentId?: string;
ids?: Iterable<string, any, any>;
page?: number;
pageSize?: number;
timeout?: number;
}
Hierarchy (View Summary)
- TimeoutOptions
- ListNetworksOptions
Properties
Optionalname
name?: string
Keeps networks with this name, matched case-insensitively.
Optionalscope
scope?: string
Keeps networks of this scope: internal, customer, or none for
networks without one.
Optionalowner
owner?: string
Keeps networks with this owner, matched case-insensitively.
Optionaldomain
domain?: string
Keeps networks of this memory domain.
OptionalparentId
parentId?: string
Keeps the children of this network. root keeps the root networks, one
per memory domain.
Optionalids
ids?: Iterable<string, any, any>
Keeps only these networks. The service bounds how many one call may name. An empty collection filters nothing, since on the wire it reads as not given.
Optionalpage
page?: number
The page to return, counting from 1. Omitted, the first.
OptionalpageSize
pageSize?: number
How many networks a page holds. Omitted, the service's default.
Optionaltimeout
timeout?: number
Seconds to wait for this call. Defaults to the client's own timeout.
What NetworkOperations.list narrows the listing by.
Every filter is optional, and those given must all match.