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

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

public class AdminResourceClass
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.ResourceClassType>

Helper class for the resource class in vCloud Extension Service API.

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Method Summary

void	delete() Delete the resource class
ReferenceResult	getAdminResourceClassActionRefs() List registered resource class actions for extension service.
static AdminResourceClass	getAdminResourceClassById(VcloudClient client, String vCloudId) Get Resource class helper using the vCloud ID
static AdminResourceClass	getAdminResourceClassByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the Resource class Helper for the given resource class reference
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminServiceReference() Returns the service reference.
ReferenceResult	getAdminServiceResourceRefs() List registered service resources for extension service.
AdminResourceClassAction	registerAdminResourceClassAction(com.vmware.vcloud.api.rest.schema.extension.ResourceClassActionType resourceClasaActionParams) Registers resource class action for extension service.
AdminServiceResource	registerAdminServiceResource(com.vmware.vcloud.api.rest.schema.extension.ServiceResourceType serviceResParams) Registers service resource for extension service.
AdminResourceClassAction	registerResourceClassAction(String actionName, String actionHttpMethod, String actionURLPattern, String actionOperationKey) Creating an action which can be performed on the resource.

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

getAdminResourceClassByReference

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

Returns the Resource class Helper for the given resource class reference

Parameters:

client -

reference -

Returns:

AdminResourceClass

Throws:

VCloudException

getAdminResourceClassById

public static AdminResourceClass getAdminResourceClassById(VcloudClient client,
                                                           String vCloudId)
                                                    throws VCloudException

Get Resource class 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

delete

public void delete()
            throws VCloudException

Delete the resource class

Throws:

VCloudException

getAdminServiceReference

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

Returns the service reference.

Returns:

ReferenceType

Throws:

VCloudException

registerAdminResourceClassAction

public AdminResourceClassAction registerAdminResourceClassAction(com.vmware.vcloud.api.rest.schema.extension.ResourceClassActionType resourceClasaActionParams)
                                                          throws VCloudException

Registers resource class action for extension service. The resource class action will be added only if a resource class with the same name does not exist.

Parameters:

resourceClasaActionParams -

Returns:

AdminResourceClassAction

Throws:

VCloudException

registerResourceClassAction

public AdminResourceClassAction registerResourceClassAction(String actionName,
                                                            String actionHttpMethod,
                                                            String actionURLPattern,
                                                            String actionOperationKey)
                                                     throws VCloudException

Creating an action which can be performed on the resource.

Parameters:

actionName -

actionHttpMethod -

actionURLPattern -

actionOperationKey -

Returns:

AdminResourceClassAction

Throws:

VCloudException

Since:

API 5.1, SDK 5.5

getAdminResourceClassActionRefs

public ReferenceResult getAdminResourceClassActionRefs()
                                                throws VCloudException

List registered resource class actions for extension service.

Returns:

ReferenceResult

Throws:

VCloudException

registerAdminServiceResource

public AdminServiceResource registerAdminServiceResource(com.vmware.vcloud.api.rest.schema.extension.ServiceResourceType serviceResParams)
                                                  throws VCloudException

Registers service resource for extension service.

Parameters:

serviceResParams -

Returns:

AdminServiceResource

Throws:

VCloudException

getAdminServiceResourceRefs

public ReferenceResult getAdminServiceResourceRefs()
                                            throws VCloudException

List registered service resources for extension service.

Returns:

ReferenceResult

Throws:

VCloudException