com.hp.ov.sdk.rest.client

Class LogicalSwitchGroupClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.LogicalSwitchGroupClientImpl

All Implemented Interfaces:

LogicalSwitchGroupClient

public class LogicalSwitchGroupClientImpl
extends Object
implements LogicalSwitchGroupClient

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createLogicalSwitchGroup(RestParams params, LogicalSwitchGroup logicalSwitchGroup, boolean aSync) Creates a logical switch group according to the provided LogicalSwitchGroup object.
TaskResourceV2	deleteLogicalSwitchGroup(RestParams params, String resourceId, boolean aSync) Deletes a logical switch group identified by the provided resource identifier.
ResourceCollection<LogicalSwitchGroup>	getAllLogicalSwitchGroups(RestParams params) Retrieves the logical switch group details for all the logical switch groups under the current HPE OneView.
static LogicalSwitchGroupClient	getClient()
String	getId(RestParams params, String name) Retrieves the logical switch group resource identifier for the specified logical switch group name.
LogicalSwitchGroup	getLogicalSwitchGroup(RestParams params, String resourceId) Retrieves the LogicalSwitchGroup details for the specified logical switch group resource identifier.
LogicalSwitchGroup	getLogicalSwitchGroupByName(RestParams params, String name) Retrieves the LogicalSwitchGroup details for the specified logical switch group name.
TaskResourceV2	updateLogicalSwitchGroup(RestParams params, String resourceId, LogicalSwitchGroup logicalSwitchGroup, boolean aSync) Updates a logical switch group according to the provided LogicalSwitchGroup object.

Methods inherited from class java.lang.Object

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

Method Detail

getClient

public static LogicalSwitchGroupClient getClient()

getLogicalSwitchGroup

public LogicalSwitchGroup getLogicalSwitchGroup(RestParams params,
                                                String resourceId)

Description copied from interface: LogicalSwitchGroupClient

Retrieves the LogicalSwitchGroup details for the specified logical switch group resource identifier.

Specified by:

getLogicalSwitchGroup in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch group identifier as seen in HPE OneView.

Returns:

LogicalSwitchGroup object containing the details.

getLogicalSwitchGroupByName

public LogicalSwitchGroup getLogicalSwitchGroupByName(RestParams params,
                                                      String name)

Description copied from interface: LogicalSwitchGroupClient

Retrieves the LogicalSwitchGroup details for the specified logical switch group name.

Specified by:

getLogicalSwitchGroupByName in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

name - logical switch group name as seen in HPE OneView.

Returns:

LogicalSwitchGroup object containing the details.

getAllLogicalSwitchGroups

public ResourceCollection<LogicalSwitchGroup> getAllLogicalSwitchGroups(RestParams params)

Description copied from interface: LogicalSwitchGroupClient

Retrieves the logical switch group details for all the logical switch groups under the current HPE OneView.

Specified by:

getAllLogicalSwitchGroups in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

Returns:

ResourceCollection<LogicalSwitchGroup> containing the details for all found logical switch groups.

createLogicalSwitchGroup

public TaskResourceV2 createLogicalSwitchGroup(RestParams params,
                                               LogicalSwitchGroup logicalSwitchGroup,
                                               boolean aSync)

Description copied from interface: LogicalSwitchGroupClient

Creates a logical switch group according to the provided LogicalSwitchGroup object. The request can be processed asynchronously or synchronously.

Specified by:

createLogicalSwitchGroup in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

logicalSwitchGroup - object containing the logical switch group details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateLogicalSwitchGroup

public TaskResourceV2 updateLogicalSwitchGroup(RestParams params,
                                               String resourceId,
                                               LogicalSwitchGroup logicalSwitchGroup,
                                               boolean aSync)

Description copied from interface: LogicalSwitchGroupClient

Updates a logical switch group according to the provided LogicalSwitchGroup object. The request can be processed asynchronously or synchronously.

Specified by:

updateLogicalSwitchGroup in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch group identifier as seen in HPE OneView.

logicalSwitchGroup - object containing the logical switch group details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteLogicalSwitchGroup

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

Description copied from interface: LogicalSwitchGroupClient

Deletes a logical switch group identified by the provided resource identifier. The request can be processed asynchronously or synchronously.

Specified by:

deleteLogicalSwitchGroup in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch group identifier as seen in HPE OneView.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: LogicalSwitchGroupClient

Retrieves the logical switch group resource identifier for the specified logical switch group name.

Specified by:

getId in interface LogicalSwitchGroupClient

Parameters:

params - structure containing the connection details.

name - logical switch group name as seen in HPE OneView.

Returns:

the resource identifier for the logical switch group