com.hp.ov.sdk.rest.client

Interface NetworkSetClient

All Known Implementing Classes:

NetworkSetClientImpl

public interface NetworkSetClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createNetworkSet(RestParams params, NetworkSets networkSet, 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.
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.

Method Detail

getNetworkSets

NetworkSets getNetworkSets(RestParams params,
                           String resourceId)

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

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

NetworkSetCollection getAllNetworkSets(RestParams params)

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

Parameters:

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

Returns:

NetworkSetCollection containing a collection of network set details.

getNetworkSetsByName

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.

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

TaskResourceV2 createNetworkSet(RestParams params,
                                NetworkSets networkSet,
                                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. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

networkSet - 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

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. 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 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

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

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.

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

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.

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.