Vstats.Counters.FilterSpec

The Vstats.Counters.FilterSpec schema contains fields that can be used to filter list of counters.

Warning: this schema is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

JSON Example

{
    "cid": "string",
    "types": [
        "string"
    ],
    "metric": "string"
}

string

cid

Optional

Counter identifier that will be listed.

Warning: this property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

If missing or null counter filter will not be applied.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

array of string

types

Optional

Resource type filter.

If missing or null resource type filter will not be applied.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vstats.model.RsrcType. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vstats.model.RsrcType.

string

metric

Optional

Metric for which counters will be listed.

If missing or null metric filter will not be applied.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Metric. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Metric.