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

Interface SearchableResource<T>

All Superinterfaces:

RetrievableResource<T>

All Known Subinterfaces:

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, OsVolumeClient, PlanScriptClient, PowerDeliveryDeviceClient, RackClient, SasInterconnectClient, SasInterconnectTypeClient, SasLogicalInterconnectClient, SasLogicalInterconnectGroupClient, SasLogicalJbodAttachmentClient, SasLogicalJbodClient, ServerHardwareClient, ServerHardwareTypeClient, ServerProfileClient, ServerProfileTemplateClient, StoragePoolClient, StorageSystemClient, StorageVolumeAttachmentClient, StorageVolumeClient, StorageVolumeTemplateClient, SwitchClient, SwitchTypeClient, UnmanagedDeviceClient, UplinkSetClient

public interface SearchableResource<T>
extends RetrievableResource<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SearchableResource.GetByNameRequestInterceptor

Method Summary

Modifier and Type	Method and Description
ResourceCollection<T>	getByName(String name) Retrieves a paginated collection (ResourceCollection) containing the details for the available resources found under the current HPE OneView that match the name provided.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Method Detail

getByName

ResourceCollection<T> getByName(String name)

Retrieves a paginated collection (ResourceCollection) containing the details for the available resources found under the current HPE OneView that match the name provided.

The filter applied in this case is as follows:

     filter="name matches 'name'"
 

Parameters:

name - name that should be used to filter the resources found in HPE OneView.

Returns:

ResourceCollection paginated collection containing the details for the available resources if type <T> that match the filter.