com.hp.ov.sdk.rest.client

Class UplinkSetClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.UplinkSetClientImpl

All Implemented Interfaces:

UplinkSetClient

public class UplinkSetClientImpl
extends Object
implements UplinkSetClient

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UplinkSetClientImpl(UplinkSetAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

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.
static UplinkSetClient	getClient()
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 name) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Detail

UplinkSetClientImpl

protected UplinkSetClientImpl(UplinkSetAdaptor adaptor,
                              TaskAdaptor taskAdaptor,
                              TaskMonitorManager taskMonitor)

Method Detail

getClient

public static UplinkSetClient getClient()

getUplinkSet

public UplinkSets getUplinkSet(RestParams params,
                               String resourceId)

Description copied from interface: UplinkSetClient

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

Specified by:

getUplinkSet in interface UplinkSetClient

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

public UplinkSetCollectionV2 getAllUplinkSet(RestParams params)

Description copied from interface: UplinkSetClient

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

Specified by:

getAllUplinkSet in interface UplinkSetClient

Parameters:

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

Returns:

UplinkSetCollectionV2 containing a collection of uplink set details.

deleteUplinkSet

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

Description copied from interface: UplinkSetClient

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

Specified by:

deleteUplinkSet in interface UplinkSetClient

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

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

Description copied from interface: UplinkSetClient

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.

Specified by:

updateUplinkSet in interface UplinkSetClient

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

public UplinkSets getUplinkSetsByName(RestParams params,
                                      String name)

Description copied from interface: UplinkSetClient

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

Specified by:

getUplinkSetsByName in interface UplinkSetClient

Parameters:

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

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

Returns:

UplinkSets containing the uplink set details.

createUplinkSet

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

Description copied from interface: UplinkSetClient

This module aids in creation of uplink set.

Specified by:

createUplinkSet in interface UplinkSetClient

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

public String getId(RestParams params,
                    String name)

Description copied from interface: UplinkSetClient

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

Specified by:

getId in interface UplinkSetClient

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.