com.vmware.vise.data

Class PropertySpec

java.lang.Object

com.vmware.vise.data.PropertySpec

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

OrderingPropertySpec

@data(base="Object")
public class PropertySpec
extends java.lang.Object
implements java.lang.Cloneable

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

Field Summary

Fields

Modifier and Type	Field and Description
ParameterSpec[]	parameters (Optional) The parameters that may be required to compute the properties.
java.lang.String[]	propertyNames The set of properties to be retrieved for the specified type.
java.lang.String	relation (Optional) Relationship name that determines the property path to the result object.
java.lang.String	type (Optional) Type to which the properties belong.

Constructor Summary

Constructors

Constructor and Description
PropertySpec()

Method Summary

Modifier and Type	Method and Description
PropertySpec	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

@optional
public java.lang.String type

(Optional) Type to which the properties belong.

relation

@optional
public java.lang.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".

VMODL1 property names must never be qualified with resource model name (i.e. for resource type "VirtualMachine", property "name" is valid while "VirtualMachine/name" is not). VMODL2 property names must always be qualified with resource model name.

propertyNames

public java.lang.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.

VMODL1 property names must never be qualified with resource model name (i.e. for resource type "VirtualMachine", property "name" is valid while "VirtualMachine/name" is not). VMODL2 property names must always be qualified with resource model name.

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public PropertySpec clone()
                   throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

a copy of this object.

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object