com.vmware.vcloud.sdk.admin.extensions.service
Class AdminApiDefinition

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.AdminApiDefinitionType>
          com.vmware.vcloud.sdk.admin.extensions.service.AdminApiDefinition

public class AdminApiDefinition
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.AdminApiDefinitionType>

Helper class for the api definition in vCloud Extension Service API.

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Method Summary

AdminFileDescriptor	createAdminFileDescriptor(com.vmware.vcloud.api.rest.schema.extension.AdminFileDescriptorType fileDescParams) Creates file descriptor.
void	delete() Delete the api definition
static AdminApiDefinition	getAdminApiDefinitionById(VcloudClient client, String vCloudId) Get Api definition helper using the vCloud ID
static AdminApiDefinition	getAdminApiDefinitionByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the Api Definition Helper for the given api definition reference
ReferenceResult	getAdminFileDescriptorRefs() Returns all file descriptors references for the API definition.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminServiceReference() 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

getAdminApiDefinitionByReference

public static AdminApiDefinition getAdminApiDefinitionByReference(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:

AdminApiDefinition

Throws:

VCloudException

getAdminApiDefinitionById

public static AdminApiDefinition getAdminApiDefinitionById(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:

AdminApiDefinition

Throws:

VCloudException

createAdminFileDescriptor

public AdminFileDescriptor createAdminFileDescriptor(com.vmware.vcloud.api.rest.schema.extension.AdminFileDescriptorType fileDescParams)
                                              throws VCloudException

Creates file descriptor.

Parameters:

fileDescParams -

Returns:

AdminApiDefinition

Throws:

VCloudException

getAdminFileDescriptorRefs

public ReferenceResult getAdminFileDescriptorRefs()
                                           throws VCloudException

Returns all file descriptors references for the API definition.

Returns:

ReferenceResult

Throws:

VCloudException

delete

public void delete()
            throws VCloudException

Delete the api definition

Throws:

VCloudException

getAdminServiceReference

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

Returns the service reference.

Returns:

ReferenceType

Throws:

VCloudException