com.hp.ov.sdk.rest.client.common

Interface DeletableResource

All Known Subinterfaces:

ArtifactsBundleClient, EthernetNetworkClient, FcNetworkClient, FcoeNetworkClient, FirmwareDriverClient, GoldenImageClient, LogicalEnclosureClient, LogicalInterconnectGroupClient, LogicalSwitchClient, LogicalSwitchGroupClient, NetworkSetClient, SasLogicalInterconnectGroupClient, ServerHardwareTypeClient, ServerProfileClient, ServerProfileTemplateClient, StorageVolumeClient, UplinkSetClient

public interface DeletableResource

Method Summary

Modifier and Type	Method and Description
TaskResource	delete(String resourceId, RequestOption... options) Deletes the resource identified by the provided resourceId.

Method Detail

delete

TaskResource delete(String resourceId,
                    RequestOption... options)

Deletes the resource identified by the provided resourceId.

Depending on the resource type, the delete action can take some time to complete. Therefore, you can specify a timeout using an implementation of RequestOption called TaskTimeout. If no timeout is specified, the default behavior is to wait until the delete action completes. The following example shows how to specify the timeout:

     String resourceName = "someResourceName";
     SomeResource resource = client.getByName(resourceName);
     TaskResource task = client.delete(resource.getResourceId(), TaskTimeout.of(5000)); //5 secs
 

Parameters:

resourceId - resource identifier as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource task containing the result of this request.