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

Interface RemovableResource

All Known Subinterfaces:

EnclosureClient, FcSanDeviceManagerClient, PowerDeliveryDeviceClient, ServerHardwareClient, StoragePoolClient, StorageSystemClient, SwitchClient

public interface RemovableResource

Method Summary

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

Method Detail

remove

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

Removes the resource identified by the provided resourceId.

Depending on the resource type, the remove 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 remove action completes. The following example shows how to specify the timeout:

     String resourceName = "someResourceName";
     SomeResource resource = client.getByName(resourceName);
     TaskResource task = client.remove(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.