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

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

public class AdminResourceClassAction
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.ResourceClassActionType>

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

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Constructor Summary

AdminResourceClassAction(VcloudClient client, com.vmware.vcloud.api.rest.schema.extension.ResourceClassActionType resourceClassActionParams)
Default access constructor for creating a resource class action helper class

Method Summary

void	delete() Delete the resource class action
ReferenceResult	getAdminAclRuleRefs() List registered resource class ACL rule for extension service.
static AdminResourceClassAction	getAdminResourceClassActionById(VcloudClient client, String vCloudId) Get Resource class action helper using the vCloud ID
static AdminResourceClassAction	getAdminResourceClassActionByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the Resource class Action Helper for the given resource class action reference
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminResourceClassReference() Returns the resource class reference.
AdminAclRule	registerACLRule(String ruleName, com.vmware.vcloud.api.rest.schema.extension.AclAccessType serviceAclAccess, com.vmware.vcloud.api.rest.schema.extension.AclAccessType orgAccess, com.vmware.vcloud.api.rest.schema.extension.AclAccessType principalAccess) Creating an ACL rule for the resource class action.
AdminAclRule	registerAdminAclRule(com.vmware.vcloud.api.rest.schema.extension.AclRuleType aclRuleParams) Registers resource class ACL rule for extension service.

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

Constructor Detail

AdminResourceClassAction

public AdminResourceClassAction(VcloudClient client,
                                com.vmware.vcloud.api.rest.schema.extension.ResourceClassActionType resourceClassActionParams)

Default access constructor for creating a resource class action helper class

Parameters:

client -

resourceClassActionParams - ResourceClassActionType

Method Detail

getAdminResourceClassActionByReference

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

Returns the Resource class Action Helper for the given resource class action reference

Parameters:

client -

reference -

Returns:

AdminResourceClassAction

Throws:

VCloudException

getAdminResourceClassActionById

public static AdminResourceClassAction getAdminResourceClassActionById(VcloudClient client,
                                                                       String vCloudId)
                                                                throws VCloudException

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

Throws:

VCloudException

getAdminResourceClassReference

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

Returns the resource class reference.

Returns:

ReferenceType

Throws:

VCloudException

registerAdminAclRule

public AdminAclRule registerAdminAclRule(com.vmware.vcloud.api.rest.schema.extension.AclRuleType aclRuleParams)
                                  throws VCloudException

Registers resource class ACL rule for extension service.

Parameters:

aclRuleParams -

Returns:

AdminAclRule

Throws:

VCloudException

registerACLRule

public AdminAclRule registerACLRule(String ruleName,
                                    com.vmware.vcloud.api.rest.schema.extension.AclAccessType serviceAclAccess,
                                    com.vmware.vcloud.api.rest.schema.extension.AclAccessType orgAccess,
                                    com.vmware.vcloud.api.rest.schema.extension.AclAccessType principalAccess)
                             throws VCloudException

Creating an ACL rule for the resource class action.

Parameters:

ruleName -

serviceAclAccess - possible access values are Shared, Entity(if entity, entity reference should be set)

orgAccess - possible access values are Shared, Published, Entity(if entity, entity reference should be set)

principalAccess - possible access values are Shared, Entity(if entity, entity reference should be set)

Returns:

AdminAclRule

Throws:

VCloudException

Since:

API 5.1, SDK 5.5

getAdminAclRuleRefs

public ReferenceResult getAdminAclRuleRefs()
                                    throws VCloudException

List registered resource class ACL rule for extension service.

Returns:

ReferenceResult

Throws:

VCloudException