vSphere Client SDK API Documentation : version 5.5.0.1300321

com.vmware.vise.data
Class PropertySpec

java.lang.Object
  extended by com.vmware.vise.data.PropertySpec
Direct Known Subclasses:
OrderingPropertySpec

@data(base="Object")
public class PropertySpec
extends Object

Defines the specification of the properties to be fetched via the DataService


Field Summary
 ParameterSpec[] parameters
          (Optional) The parameters that may be required to compute the properties.
 String[] propertyNames
          The set of properties to be retrieved for the specified type.
 String relation
          (Optional) Relationship name that determines the property path to the result object.
 String type
          (Optional) Type to which the properties belong.
 
Constructor Summary
PropertySpec()
           
 
Method Summary
 boolean equals(Object obj)
           
 int hashCode()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

type

@optional
public String type
(Optional) Type to which the properties belong.


relation

@optional
public String relation
(Optional) Relationship name that determines the property path to the result object.
A composite (or multi-hop) relationship is represented by a ';' separated path. For example "runtime.host;parent".


propertyNames

public String[] propertyNames
The set of properties to be retrieved for the specified type.

The property name can be annotated by "@formatted" annotation (i.e. "propName.@formatted"), which will apply a formatter to the property value. The formatter is provided by a provider of a property.


parameters

@optional
public ParameterSpec[] parameters
(Optional) The parameters that may be required to compute the properties.

See Also:
ParameterSpec
Constructor Detail

PropertySpec

public PropertySpec()
Method Detail

toString

public String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

vSphere Client SDK API Documentation : version 5.5.0.1300321

Copyright @ 2012 VMware, Inc. All rights reserved.