com.hp.ov.sdk.rest.client

Interface ConnectionTemplateClient

All Known Implementing Classes:

ConnectionTemplateClientImpl

public interface ConnectionTemplateClient

Method Summary

Modifier and Type	Method and Description
ConnectionTemplateCollection	getAllConnectionTemplates(RestParams params) The module aids in fetching the connection template details for all networks found under the current HPE OneView.
ConnectionTemplate	getConnectionTemplate(RestParams params, String id) The module aids in fetching the connection template when provided with the ConnectionTemplate resource identifier.
ConnectionTemplate	getConnectionTemplateByName(RestParams params, String resourceName) The module aids in fetching the connection template when provided with the connection template name.
ConnectionTemplate	getDefaultConnectionTemplateForConnectionTemplate(RestParams params) The module aids in fetching the default connection template details for the network found under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the connection template resource identifier for the connection template name as specified in HPE OneView.
ConnectionTemplate	updateConnectionTemplate(RestParams params, String resourceId, ConnectionTemplate connectionTemplateDto, boolean useJsonRequest) The module takes in a ConnectionTemplate object or JsonRequest and updates the existing connection template based on the resource identifier.

Method Detail

getConnectionTemplate

ConnectionTemplate getConnectionTemplate(RestParams params,
                                         String id)

The module aids in fetching the connection template when provided with the ConnectionTemplate resource identifier.

Parameters:

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

id - The resource identifier for the connection template as seen in HPE OneView.

Returns:

ConnectionTemplate containing the connection template details.

getConnectionTemplateByName

ConnectionTemplate getConnectionTemplateByName(RestParams params,
                                               String resourceName)

The module aids in fetching the connection template when provided with the connection template name.

Parameters:

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

resourceName - The resourceName is the connection template name as seen in HPE OneView.

Returns:

ConnectionTemplate containing the connection template details.

updateConnectionTemplate

ConnectionTemplate updateConnectionTemplate(RestParams params,
                                            String resourceId,
                                            ConnectionTemplate connectionTemplateDto,
                                            boolean useJsonRequest)

The module takes in a ConnectionTemplate object or JsonRequest and updates the existing connection template based on the resource identifier.

Parameters:

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

resourceId - The resource identifier for the connection template as seen in HPE OneView.

connectionTemplateDto - This is a object containing the update to be made to an existing ConnectionTemplate pointed to by the above mentioned resource identifier.

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

Returns:

ConnectionTemplate containing the updated connection template details.

getAllConnectionTemplates

ConnectionTemplateCollection getAllConnectionTemplates(RestParams params)

The module aids in fetching the connection template details for all networks found under the current HPE OneView.

Parameters:

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

Returns:

ConnectionTemplateCollection containing the collection of connection template details.

getDefaultConnectionTemplateForConnectionTemplate

ConnectionTemplate getDefaultConnectionTemplateForConnectionTemplate(RestParams params)

The module aids in fetching the default connection template details for the network found under the current HPE OneView.

Parameters:

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

Returns:

ConnectionTemplate containing the connection template details.

getId

String getId(RestParams params,
             String name)

The module aids in fetching the connection template resource identifier for the connection template name as specified in HPE OneView.

Parameters:

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

name - The name is the connection template name as seen in HPE OneView.

Returns:

String which is the resource identifier for the connection template name as seen in HPE OneView.