com.vmware.vcloud.sdk.admin.extensions
Class StrandedItem

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.StrandedItemType>
          com.vmware.vcloud.sdk.admin.extensions.StrandedItem

public class StrandedItem
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.StrandedItemType>

Helper class for the Stranded Item Resource in vCloud Admin Extension API.

Since:

API 5.1, SDK 5.1

Author:

Ecosystem Engineering

Method Summary

Task	delete() Delete the stranded item.
static Task	delete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType strandedItemRef) Delete the StrandedItem.
Task	forceDelete() Force delete the stranded item.
static Task	forceDelete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType strandedItemRef) Force delete the stranded item.
static StrandedItem	getStrandedItemById(VcloudClient client, String vCloudId) Get StrandedItem helper using the vCloud ID
static StrandedItem	getStrandedItemByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the StrandedItem Helper for the given stranded item 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

getStrandedItemByReference

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

Returns the StrandedItem Helper for the given stranded item reference

Parameters:

client -

reference -

Returns:

StrandedItem

Throws:

VCloudException

getStrandedItemById

public static StrandedItem getStrandedItemById(VcloudClient client,
                                               String vCloudId)
                                        throws VCloudException

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

StrandedItem

Throws:

VCloudException

delete

public Task delete()
            throws VCloudException

Delete the stranded item.

Returns:

Task

Throws:

VCloudException

delete

public static Task delete(VcloudClient client,
                          com.vmware.vcloud.api.rest.schema.ReferenceType strandedItemRef)
                   throws VCloudException

Delete the StrandedItem.

Parameters:

client - VcloudClient

strandedItemRef -

Returns:

Task

Throws:

VCloudException

forceDelete

public Task forceDelete()
                 throws VCloudException

Force delete the stranded item.

Returns:

Task

Throws:

VCloudException

forceDelete

public static Task forceDelete(VcloudClient client,
                               com.vmware.vcloud.api.rest.schema.ReferenceType strandedItemRef)
                        throws VCloudException

Force delete the stranded item.

Parameters:

client - VcloudClient

strandedItemRef -

Returns:

Task

Throws:

VCloudException