com.vmware.vstats

Class DataTypes.FilterSpec.Builder

java.lang.Object

com.vmware.vstats.DataTypes.FilterSpec.Builder

Enclosing class:

DataTypes.FilterSpec

public static final class DataTypes.FilterSpec.Builder
extends java.lang.Object

Builder class for DataTypes.FilterSpec.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of DataTypes.FilterSpec.

Method Summary

Modifier and Type	Method and Description
DataTypes.FilterSpec	build()
DataTypes.FilterSpec.Builder	setCid(java.lang.String cid) Counter ID.
DataTypes.FilterSpec.Builder	setEnd(java.lang.Long end) End of a time window (excluded), timestamp in seconds UTC.
DataTypes.FilterSpec.Builder	setMetric(java.lang.String metric) Metric name.
DataTypes.FilterSpec.Builder	setOrder(java.lang.String order) Directs the server to order the returned data.
DataTypes.FilterSpec.Builder	setPage(java.lang.String page) Used to retrieve paged data for larger result sets.
DataTypes.FilterSpec.Builder	setResources(java.util.List<java.lang.String> resources) Resources to include in the query.
DataTypes.FilterSpec.Builder	setStart(java.lang.Long start) Start of a time window (included), timestamp in seconds UTC.
DataTypes.FilterSpec.Builder	setTypes(java.util.List<java.lang.String> types) List of Resource types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of DataTypes.FilterSpec.

Method Detail

setStart

public DataTypes.FilterSpec.Builder setStart(java.lang.Long start)

Start of a time window (included), timestamp in seconds UTC. 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. When null the result will not be limited by start time.

Parameters:

start - New value for the property.

setEnd

public DataTypes.FilterSpec.Builder setEnd(java.lang.Long end)

End of a time window (excluded), timestamp in seconds UTC. 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. When null the result will not be limited by end time.

Parameters:

end - New value for the property.

setCid

public DataTypes.FilterSpec.Builder setCid(java.lang.String cid)

Counter ID. 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. When null the result will not be filtered by counter.

Parameters:

cid - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

setMetric

public DataTypes.FilterSpec.Builder setMetric(java.lang.String metric)

Metric name. 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. When null the result will not be filtered by metric name.

Parameters:

metric - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Metric. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vstats.model.Metric.

setTypes

public DataTypes.FilterSpec.Builder setTypes(java.util.List<java.lang.String> types)

List of Resource types. 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. When null the result will not be filtered by resource types.

Parameters:

types - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.vstats.model.RsrcType. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.vstats.model.RsrcType.

setResources

public DataTypes.FilterSpec.Builder setResources(java.util.List<java.lang.String> resources)

Resources to include in the query. Each resource is specified through a composite string that follows the following format.

type.<resource type>[.<scheme>]=<resource id>

resource type specifies the type of resource for example VM, VCPU etc.

scheme is an optional element to disambiguate the resource as needed for example to differentiate managed object id from uuid.

resource id is the unique resource identifier value for example: vm-41

Example values include: type.VM=vm-41, type.VCPU=1, type.VM.moid=vm-41

. 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. When left null the result will not be filtered for specific resources.

Parameters:

resources - New value for the property.

setOrder

public DataTypes.FilterSpec.Builder setOrder(java.lang.String order)

Directs the server to order the returned data. Passing a value of DEFAULT will apply default ordering of the results that makes them easier for consumption. 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. When this parameter is null the server will not order the result, save computational time and therefore the API will operate faster.

Parameters:

order - New value for the property.

setPage

public DataTypes.FilterSpec.Builder setPage(java.lang.String page)

Used to retrieve paged data for larger result sets. The value of this token is generated by server and returned as next property in the result of queryDataPoints() methods. 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. When null the first page of results will be returned.

Parameters:

page - New value for the property.

build

public DataTypes.FilterSpec build()