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

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<com.vmware.vcloud.api.rest.schema.extension.AdminFileDescriptorType>
      com.vmware.vcloud.sdk.admin.extensions.service.AdminFileDescriptor

public class AdminFileDescriptor
extends VcloudResource<com.vmware.vcloud.api.rest.schema.extension.AdminFileDescriptorType>

Helper class for the file descriptor in vCloud Extension Service API.

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Method Summary

void	delete() Delete the file descriptor
static AdminFileDescriptor	getAdminFileDescriptorById(VcloudClient client, String vCloudId) Get FileDescriptor helper using the vCloud ID
static AdminFileDescriptor	getAdminFileDescriptorByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the file descriptor Helper for the given file descriptor reference
com.vmware.vcloud.api.rest.schema.ReferenceType	getApiDefinitionReference() Returns the api definition reference.

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

getReference, getResource

Methods inherited from class java.lang.Object

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

Method Detail

getAdminFileDescriptorByReference

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

Returns the file descriptor Helper for the given file descriptor reference

Parameters:

client -

reference -

Returns:

AdminFileDescriptor

Throws:

VCloudException

getAdminFileDescriptorById

public static AdminFileDescriptor getAdminFileDescriptorById(VcloudClient client,
                                                             String vCloudId)
                                                      throws VCloudException

Get FileDescriptor 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:

AdminFileDescriptor

Throws:

VCloudException

delete

public void delete()
            throws VCloudException

Delete the file descriptor

Throws:

VCloudException

getApiDefinitionReference

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

Returns the api definition reference.

Returns:

ReferenceType

Throws:

VCloudException