com.hp.ov.sdk.rest.client

Class NetworkSetClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.NetworkSetClientImpl

All Implemented Interfaces:

NetworkSetClient

public class NetworkSetClientImpl
extends Object
implements NetworkSetClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkSetClientImpl(NetworkSetAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createNetworkSet(RestParams params, NetworkSets networkSetDto, boolean aSync, boolean useJsonRequest) The module aids in the creation of a network set when provided with the network set details as a NetworkSets object or JsonRequest.
TaskResourceV2	deleteNetworkSet(RestParams params, String resourceId, boolean aSync) The module aids in deleting a network set for the specified network set resource identifier.
NetworkSetCollection	getAllNetworkSets(RestParams params) The module aids in fetching the network set details for all the network sets found under the current HPE OneView.
static NetworkSetClient	getClient()
String	getId(RestParams params, String name) The module aids in fetching the network set resource identifier for the network set name as specified in HPE OneView.
NetworkSets	getNetworkSets(RestParams params, String resourceId) The module aids in fetching the network set details for the specified network set resource identifier.
NetworkSets	getNetworkSetsByName(RestParams params, String name) The module aids in fetching the network set details for the network set name as specified in HPE OneView.
TaskResourceV2	updateNetworkSet(RestParams params, String resourceId, NetworkSets networkSetDto, boolean aSync, boolean useJsonRequest) The module takes in a NetworkSet object or JsonRequest and updates the existing network set based on the resource identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkSetClientImpl

protected NetworkSetClientImpl(NetworkSetAdaptor adaptor,
                               TaskAdaptor taskAdaptor,
                               TaskMonitorManager taskMonitor)

Method Detail

getClient

public static NetworkSetClient getClient()

getNetworkSets

public NetworkSets getNetworkSets(RestParams params,
                                  String resourceId)

Description copied from interface: NetworkSetClient

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

Specified by:

getNetworkSets in interface NetworkSetClient

Parameters:

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

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

Returns:

NetworkSets containing the network set details.

getAllNetworkSets

public NetworkSetCollection getAllNetworkSets(RestParams params)

Description copied from interface: NetworkSetClient

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

Specified by:

getAllNetworkSets in interface NetworkSetClient

Parameters:

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

Returns:

NetworkSetCollection containing a collection of network set details.

getNetworkSetsByName

public NetworkSets getNetworkSetsByName(RestParams params,
                                        String name)

Description copied from interface: NetworkSetClient

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

Specified by:

getNetworkSetsByName in interface NetworkSetClient

Parameters:

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

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

Returns:

NetworkSets containing the network set details.

createNetworkSet

public TaskResourceV2 createNetworkSet(RestParams params,
                                       NetworkSets networkSetDto,
                                       boolean aSync,
                                       boolean useJsonRequest)

Description copied from interface: NetworkSetClient

The module aids in the creation of a network set when provided with the network set details as a NetworkSets object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

createNetworkSet in interface NetworkSetClient

Parameters:

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

networkSetDto - Object containing the network set details, used to create a network set.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of NetworkSets object which takes in a String containing the new network set details, which is converted to a NetworkSets object using an adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

updateNetworkSet

public TaskResourceV2 updateNetworkSet(RestParams params,
                                       String resourceId,
                                       NetworkSets networkSetDto,
                                       boolean aSync,
                                       boolean useJsonRequest)

Description copied from interface: NetworkSetClient

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

Specified by:

updateNetworkSet in interface NetworkSetClient

Parameters:

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

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

networkSetDto - Object containing the network set details, used to update a network set.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteNetworkSet

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

Description copied from interface: NetworkSetClient

The module aids in deleting a network set for the specified network set resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

deleteNetworkSet in interface NetworkSetClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: NetworkSetClient

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

Specified by:

getId in interface NetworkSetClient

Parameters:

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

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

Returns:

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