com.hp.ov.sdk.rest.client

Interface UplinkSetClient

All Known Implementing Classes:

UplinkSetClientImpl

public interface UplinkSetClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createUplinkSet(RestParams params, UplinkSets uplinkSetDto, boolean aSync, boolean useJsonRequest) This module aids in creation of uplink set.
TaskResourceV2	deleteUplinkSet(RestParams params, String resourceId, boolean aSync) The module aids in deleting a uplink set for the specified uplink set resource identifier.
UplinkSetCollectionV2	getAllUplinkSet(RestParams params) The module aids in fetching the uplink set details for all the uplink sets found under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the uplink set resource identifier for the uplink set name as specified in HPE OneView.
UplinkSets	getUplinkSet(RestParams params, String resourceId) The module aids in fetching the uplink set details for the specified uplink set resource identifier.
UplinkSets	getUplinkSetsByName(RestParams params, String uplinkSetName) The module aids in fetching the uplink set details for the specified uplink set name as specified in HPE OneView.
TaskResourceV2	updateUplinkSet(RestParams params, String resourceId, UplinkSets uplinkDto, boolean aSync, boolean useJsonRequest) The module takes in an UplinkSet object or a JsonRequest and updates the existing uplink set based on the resource identifier.

Method Detail

getUplinkSet

UplinkSets getUplinkSet(RestParams params,
                        String resourceId)

The module aids in fetching the uplink set details for the specified uplink set resource identifier.

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for uplink set as seen in HPE OneView.

Returns:

UplinkSets containing a the uplink set details.

getAllUplinkSet

UplinkSetCollectionV2 getAllUplinkSet(RestParams params)

The module aids in fetching the uplink set details for all the uplink sets found under the current HPE OneView.

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

UplinkSetCollectionV2 containing a collection of uplink set details.

deleteUplinkSet

TaskResourceV2 deleteUplinkSet(RestParams params,
                               String resourceId,
                               boolean aSync)

The module aids in deleting a uplink set for the specified uplink set resource identifier.

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for uplink set as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateUplinkSet

TaskResourceV2 updateUplinkSet(RestParams params,
                               String resourceId,
                               UplinkSets uplinkDto,
                               boolean aSync,
                               boolean useJsonRequest)

The module takes in an UplinkSet object or a JsonRequest and updates the existing uplink set based on the resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for uplink set as seen in HPE OneView.

uplinkDto - Object containing the uplink set details, used to update a uplink set.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of UplinkSet object which takes in a String containing the update to be made, which is converted to UplinkSet object using an adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

getUplinkSetsByName

UplinkSets getUplinkSetsByName(RestParams params,
                               String uplinkSetName)

The module aids in fetching the uplink set details for the specified uplink set name as specified in HPE OneView.

Parameters:

params - The RestParams is a structure containing the connection details.

uplinkSetName - The uplinkSetName is the uplink set name as seen in HPE OneView.

Returns:

UplinkSets containing the uplink set details.

createUplinkSet

TaskResourceV2 createUplinkSet(RestParams params,
                               UplinkSets uplinkSetDto,
                               boolean aSync,
                               boolean useJsonRequest)

This module aids in creation of uplink set.

Parameters:

params - The RestParams is a structure containing the connection details.

uplinkSetDto - Object containing the uplink set details, used to create a uplink set.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of UplinkSet object which takes in a String containing the update to be made, which is converted to UplinkSets object using an adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

getId

String getId(RestParams params,
             String name)

The module aids in fetching the uplink set resource identifier for the uplink set name as specified in HPE OneView.

Parameters:

params - The RestParams is a structure containing the connection details.

name - The name is the uplink set name as seen in HPE OneView.

Returns:

String which is the resource identifier for the uplink set name as seen in HPE OneView.