public static final class DataTypes.FilterSpec extends java.lang.Object implements java.io.Serializable, StaticStructure
FilterSpec
class contains properties used to filter the results when
listing DataPoint. Warning: This class 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.Modifier and Type | Class and Description |
---|---|
static class |
DataTypes.FilterSpec.Builder
Builder class for
DataTypes.FilterSpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
FilterSpec()
Default constructor.
|
protected |
FilterSpec(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get dynamic filed value.
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static DataTypes.FilterSpec |
_newInstance(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
static DataTypes.FilterSpec |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCid()
Counter ID.
|
java.lang.Long |
getEnd()
End of a time window (excluded), timestamp in seconds UTC.
|
java.lang.String |
getMetric()
Metric name.
|
java.lang.String |
getOrder()
Directs the server to order the returned data.
|
java.lang.String |
getPage()
Used to retrieve paged data for larger result sets.
|
java.util.List<java.lang.String> |
getResources()
Resources to include in the query.
|
java.lang.Long |
getStart()
Start of a time window (included), timestamp in seconds UTC.
|
java.util.List<java.lang.String> |
getTypes()
List of Resource types.
|
int |
hashCode() |
void |
setCid(java.lang.String cid)
Counter ID.
|
void |
setEnd(java.lang.Long end)
End of a time window (excluded), timestamp in seconds UTC.
|
void |
setMetric(java.lang.String metric)
Metric name.
|
void |
setOrder(java.lang.String order)
Directs the server to order the returned data.
|
void |
setPage(java.lang.String page)
Used to retrieve paged data for larger result sets.
|
void |
setResources(java.util.List<java.lang.String> resources)
Resources to include in the query.
|
void |
setStart(java.lang.Long start)
Start of a time window (included), timestamp in seconds UTC.
|
void |
setTypes(java.util.List<java.lang.String> types)
List of Resource types.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public FilterSpec()
protected FilterSpec(StructValue __dynamicStructureFields)
public java.lang.Long getStart()
null
the result will not be limited by start time.public void setStart(java.lang.Long start)
null
the result will not be limited by start time.start
- New value for the property.public java.lang.Long getEnd()
null
the result will not be limited by end time.public void setEnd(java.lang.Long end)
null
the result will not be limited by end time.end
- New value for the property.public java.lang.String getCid()
null
the result will not be filtered by counter.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 void 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 java.lang.String getMetric()
null
the result will not be filtered by metric name.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 void 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 java.util.List<java.lang.String> getTypes()
null
the result will not be filtered by resource types.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 void 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 java.util.List<java.lang.String> getResources()
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.public void 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 java.lang.String getOrder()
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.public void 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 java.lang.String getPage()
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.public void 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 com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static DataTypes.FilterSpec _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
public static DataTypes.FilterSpec _newInstance2(StructValue structValue)