com.vmware.vcloud.api.rest.client

Enum QueryResultFormat

java.lang.Object

java.lang.Enum<QueryResultFormat>

com.vmware.vcloud.api.rest.client.QueryResultFormat

All Implemented Interfaces:

Serializable, Comparable<QueryResultFormat>

public enum QueryResultFormat
extends Enum<QueryResultFormat>

Form of result returned by a query.

Since:

vCloud API 1.5.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ID_RECORDS Return records from the query, where references to other entities are typed by vCloud globally-unique ID rather than by Entity.
RECORDS Return records from the query.
REFERENCES Return references only from the query.

Method Summary

Modifier and Type	Method and Description
String	getApiString()
String	getMediaType()
static QueryResultFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryResultFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECORDS

public static final QueryResultFormat RECORDS

Return records from the query. The return type of such a query will be a List of objects which are assignable to QueryResultRecordType.

Since:

vCloud API 1.5.

ID_RECORDS

public static final QueryResultFormat ID_RECORDS

Return records from the query, where references to other entities are typed by vCloud globally-unique ID rather than by Entity. The return type of such a query will be a List of objects which are assignable to QueryResultRecordType.

Since:

vCloud API 1.5.

REFERENCES

public static final QueryResultFormat REFERENCES

Return references only from the query. The return type of such a query will be a List of EntityType or ResourceType instances.

Since:

vCloud API 1.5.

Method Detail

values

public static QueryResultFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QueryResultFormat c : QueryResultFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueryResultFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMediaType

public String getMediaType()

getApiString

public String getApiString()