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

Interface RetrievableResource<T>

All Known Subinterfaces:

AlertClient, ArtifactsBundleClient, ConnectionTemplateClient, DataCenterClient, DeploymentGroupClient, DeploymentPlanClient, DriveEnclosureClient, EnclosureClient, EnclosureGroupClient, EthernetNetworkClient, FabricClient, FcNetworkClient, FcoeNetworkClient, FcSanDeviceManagerClient, FcSanManagedSanClient, FcSanProviderClient, FirmwareDriverClient, GoldenImageClient, InterconnectClient, InterconnectLinkTopologyClient, InterconnectTypeClient, InternalLinkSetClient, LogicalDownlinkClient, LogicalEnclosureClient, LogicalInterconnectClient, LogicalInterconnectGroupClient, LogicalSwitchClient, LogicalSwitchGroupClient, NetworkSetClient, OsBuildPlanClient, OsDeploymentPlanClient, OsVolumeClient, PlanScriptClient, PowerDeliveryDeviceClient, RackClient, SasInterconnectClient, SasInterconnectTypeClient, SasLogicalInterconnectClient, SasLogicalInterconnectGroupClient, SasLogicalJbodAttachmentClient, SasLogicalJbodClient, ScopeClient, SearchableResource<T>, ServerHardwareClient, ServerHardwareTypeClient, ServerProfileClient, ServerProfileTemplateClient, StoragePoolClient, StorageSystemClient, StorageVolumeAttachmentClient, StorageVolumeClient, StorageVolumeTemplateClient, SwitchClient, SwitchTypeClient, UnmanagedDeviceClient, UplinkSetClient

public interface RetrievableResource<T>

Method Summary

Modifier and Type	Method and Description
ResourceCollection<T>	get() Retrieves a paginated collection (ResourceCollection) containing the details for the available resources of type <T> found under the current HPE OneView.
ResourceCollection<T>	get(URIQuery query) Retrieves a paginated collection (ResourceCollection) containing the details for the available resources of type <T> found under the current HPE OneView.
ResourceCollection<T>	getAll() Retrieves a collection (ResourceCollection) containing the details for all available resources of type <T> found under the current HPE OneView.
ResourceCollection<T>	getAll(int count) Retrieves a collection (ResourceCollection) containing the details for all available resources of type <T> found under the current HPE OneView.
T	getById(String resourceId) Retrieves the resource identified by the provided resourceId.

Method Detail

getById

T getById(String resourceId)

Retrieves the resource identified by the provided resourceId.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

object containing the details of the resource identified by resourceId.

get

ResourceCollection<T> get()

Retrieves a paginated collection (ResourceCollection) containing the details for the available resources of type <T> found under the current HPE OneView.

Returns:

ResourceCollection paginated collection containing the details for the available resources.

get

ResourceCollection<T> get(URIQuery query)

Retrieves a paginated collection (ResourceCollection) containing the details for the available resources of type <T> found under the current HPE OneView.

Parameters:

query - URI query containing the parameters that should be used to build the request.

Returns:

ResourceCollection paginated collection containing the details for the available resources.

getAll

ResourceCollection<T> getAll()

Retrieves a collection (ResourceCollection) containing the details for all available resources of type <T> found under the current HPE OneView.

Returns:

ResourceCollection collection containing the details for the available resources.

getAll

ResourceCollection<T> getAll(int count)

Retrieves a collection (ResourceCollection) containing the details for all available resources of type <T> found under the current HPE OneView.

Parameters:

count - defines the number of resources that should be retrieved in each request.

Returns:

ResourceCollection collection containing the details for the available resources.