FolderFilterSpec

The Folder.FilterSpec structure contains fields used to filter the results when listing folders (see Folder.list). If multiple fields are specified, only folders matching all of the fields match the filter.


Properties

array of string
datacenters Optional

Datacenters that must contain the folder for the folder to match the filter. If unset or empty, folder in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.


array of string
folders Optional

Identifiers of folders that can match the filter. If unset or empty, folders with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.


array of string
names Optional

Names that folders must have to match the filter (see Folder.Summary.name). If unset or empty, folders with any name match the filter.


array of string
parent_folders Optional

Folders that must contain the folder for the folder to match the filter. If unset or empty, folder in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.


type Optional

Type that folders must have to match the filter (see Folder.Summary.type). If unset, folders with any type match the filter.

Possible values are: DATACENTERDATASTOREHOSTNETWORKVIRTUAL_MACHINE

JSON Example

{
    "datacenters": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "names": [
        "string"
    ],
    "parent_folders": [
        "string"
    ],
    "type": "enum"
}
Feedback

Was this page helpful?