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

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

public class AdminApiFilter
extends VcloudResource<com.vmware.vcloud.api.rest.schema.extension.ApiFilterType>

Helper class for the Api filter in vCloud Extension Service API.

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Method Summary

void	delete() Delete the Api filter
static AdminApiFilter	getApiFilterById(VcloudClient client, String vCloudId) Get ApiFilter helper using the vCloud ID
static AdminApiFilter	getApiFilterByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the Api filter Helper for the given Api filter reference
com.vmware.vcloud.api.rest.schema.ReferenceType	getServiceReference() Returns the service 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

getApiFilterByReference

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

Returns the Api filter Helper for the given Api filter reference

Parameters:

client -

reference -

Returns:

AdminApiFilter

Throws:

VCloudException

getApiFilterById

public static AdminApiFilter getApiFilterById(VcloudClient client,
                                              String vCloudId)
                                       throws VCloudException

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

AdminApiFilter

Throws:

VCloudException

delete

public void delete()
            throws VCloudException

Delete the Api filter

Throws:

VCloudException

getServiceReference

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

Returns the service reference.

Returns:

ReferenceType

Throws:

VCloudException