com.vmware.vise.data.query

Class QuerySpec

java.lang.Object

com.vmware.vise.data.query.QuerySpec

All Implemented Interfaces:

java.lang.Cloneable

public class QuerySpec
extends java.lang.Object
implements java.lang.Cloneable

Defines the query to match a set of resources for which data is requested from the DataService.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name An optional query name given by the client for id purposes.
java.util.Map<java.lang.String,java.lang.Object>	options Optional information for this query's execution.
ResourceSpec	resourceSpec Specifies the target set of resources.
ResultSpec	resultSpec Additional transformations/filters to be applied on the discovered resource set.

Constructor Summary

Constructors

Constructor and Description
QuerySpec() Default constructor.
QuerySpec(QuerySpec original) Creates a shallow copy of the specified QuerySpec.

Method Summary

Modifier and Type	Method and Description
QuerySpec	clone() Creates and returns a copy of this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

@optional
public java.lang.String name

An optional query name given by the client for id purposes.

resourceSpec

public ResourceSpec resourceSpec

Specifies the target set of resources. This is how you can target specific object types and associated properties.

resultSpec

@optional
public ResultSpec resultSpec

Additional transformations/filters to be applied on the discovered resource set. If you don't specify it in your QuerySpec a default ResultSpec is created by the Data Service.

options

@optional
public java.util.Map<java.lang.String,java.lang.Object> options

Optional information for this query's execution. May contain Data Service options as well as options specific to particular adapter(s).

Constructor Detail

QuerySpec

public QuerySpec()

Default constructor.

QuerySpec

public QuerySpec(QuerySpec original)

Creates a shallow copy of the specified QuerySpec.

Parameters:

original - the object that must be copied

Method Detail

clone

public QuerySpec 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