vSphere Client SDK API Documentation : version 5.5.0.1300321

com.vmware.vise.data.query
Class TypeInfo

java.lang.Object
  extended by com.vmware.vise.data.query.TypeInfo

public class TypeInfo
extends Object

Class representing a type and its properties.

example: TypeInfo is used to indicate the types and properties handled by a PropertyProviderAdapter during its registration:

 public MyDataProviderImpl(DataServiceExtensionRegistry registry) {
    registry.registerDataAdapter(this, getProvidedTypeInfos());
 }

 private TypeInfo[] getProvidedTypeInfos() {
    // This data adapter handles 2 VM properties
    TypeInfo vmTypeInfo = new TypeInfo();
    vmTypeInfo.type = "VirtualMachine";
    vmTypeInfo.properties = new String[] { "samples:vmProp1", "samples:vmProp2" };

    return new TypeInfo[] { vmTypeInfo };
 }
 


Field Summary
static String ALL_TYPES_WILDCARD
          A value indicating that all types are included.
 com.vmware.vise.data.query.ComputedPropertyInfo[] computedProperties
          Optional info describing native properties for each computed property.
static String DEFAULT_OBJECT_TYPE
          The supertype of all types.
 String[] properties
          The array of properties considered for that type.
 String type
          The object type.
 
Constructor Summary
TypeInfo()
           
 
Method Summary
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALL_TYPES_WILDCARD

public static final String ALL_TYPES_WILDCARD
A value indicating that all types are included.
Note: this name is for INTERNAL USE only and not part of the Public SDK.

See Also:
Constant Field Values

DEFAULT_OBJECT_TYPE

public static final String DEFAULT_OBJECT_TYPE
The supertype of all types.

See Also:
Constant Field Values

type

public String type
The object type.


properties

public String[] properties
The array of properties considered for that type.


computedProperties

@optional
public com.vmware.vise.data.query.ComputedPropertyInfo[] computedProperties
Optional info describing native properties for each computed property.
Note: this field is for INTERNAL USE only and not part of the Public SDK.

Constructor Detail

TypeInfo

public TypeInfo()
Method Detail

toString

public String toString()
Overrides:
toString in class Object

vSphere Client SDK API Documentation : version 5.5.0.1300321

Copyright @ 2012 VMware, Inc. All rights reserved.