public static final class DataTypes.FilterSpec.Builder
extends java.lang.Object
DataTypes.FilterSpec
.Constructor and Description |
---|
Builder()
Constructor with parameters for the required properties of
DataTypes.FilterSpec . |
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.
|
public Builder()
DataTypes.FilterSpec
.public DataTypes.FilterSpec.Builder setStart(java.lang.Long start)
null
the result will not be limited by start time.start
- New value for the property.public DataTypes.FilterSpec.Builder setEnd(java.lang.Long end)
null
the result will not be limited by end time.end
- New value for the property.public DataTypes.FilterSpec.Builder setCid(java.lang.String cid)
null
the result will not be filtered by counter.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
.public DataTypes.FilterSpec.Builder setMetric(java.lang.String metric)
null
the result will not be filtered by metric name.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
.public DataTypes.FilterSpec.Builder setTypes(java.util.List<java.lang.String> types)
null
the result will not be filtered by resource types.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
.public DataTypes.FilterSpec.Builder setResources(java.util.List<java.lang.String> resources)
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
null
the result will not be filtered for specific resources.resources
- New value for the property.public DataTypes.FilterSpec.Builder setOrder(java.lang.String order)
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.order
- New value for the property.public DataTypes.FilterSpec.Builder setPage(java.lang.String page)
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.page
- New value for the property.public DataTypes.FilterSpec build()