com.vmware.vcloud.sdk
Class ApiDefinition

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.ApiDefinitionType>
          com.vmware.vcloud.sdk.ApiDefinition

public class ApiDefinition
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.ApiDefinitionType>

Helper class for the api definition in vCloud User API.

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Method Summary

static ApiDefinition	getApiDefinitionById(VcloudClient client, String vCloudId) Get Api definition helper using the vCloud ID
static ApiDefinition	getApiDefinitionByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the Api Definition Helper for the given api definition reference
RecordResult<com.vmware.vcloud.api.rest.schema.QueryResultFileDescriptorRecordType>	getFileDescriptorRecords() Returns all file descriptors references for the API definition.
com.vmware.vcloud.api.rest.schema.ReferenceType	getServiceReference() Returns the service reference.

Methods inherited from class com.vmware.vcloud.sdk.VcloudEntity

getMetadata, getReference, getTasks

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getResource

Methods inherited from class java.lang.Object

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

Method Detail

getApiDefinitionByReference

public static ApiDefinition getApiDefinitionByReference(VcloudClient client,
                                                        com.vmware.vcloud.api.rest.schema.ReferenceType reference)
                                                 throws VCloudException

Returns the Api Definition Helper for the given api definition reference

Parameters:

client -

reference -

Returns:

ApiDefinition

Throws:

VCloudException

getApiDefinitionById

public static ApiDefinition getApiDefinitionById(VcloudClient client,
                                                 String vCloudId)
                                          throws VCloudException

Get Api definition helper using the vCloud ID

Parameters:

client - VcloudClient

vCloudId - format - The vCloud ID is of the form: "urn:vcloud:type:uuid". For example: "urn:vcloud:media:d9d976ba-e0ec-4682-a67d-380af49b54e1". String

Returns:

ApiDefinition

Throws:

VCloudException

getFileDescriptorRecords

public RecordResult<com.vmware.vcloud.api.rest.schema.QueryResultFileDescriptorRecordType> getFileDescriptorRecords()
                                                                                                             throws VCloudException

Returns all file descriptors references for the API definition.

Returns:

RecordResult<QueryResultFileDescriptorRecordType>

Throws:

VCloudException

getServiceReference

public com.vmware.vcloud.api.rest.schema.ReferenceType getServiceReference()
                                                                    throws VCloudException

Returns the service reference.

Returns:

ReferenceType

Throws:

VCloudException