Package api.equinix.javasdk.networkedge.client

Interface Devices

All Known Implementing Classes:

DevicesImpl

public interface Devices

Client interface for managing Network Edge virtual devices. Provides operations to list, retrieve, and create devices, as well as manage device types, network interfaces, and license files.

Version:

$Id: $Id

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
DeviceOperator.DeviceBuilder	define(String deviceName)	Returns an instance of DeviceBuilder for defining a new device.
DeviceOperator.DeviceBuilderSecondary	defineSecondary(String secondaryDeviceName, String primaryDeviceUuid)	Returns an instance of DeviceBuilderSecondary for defining a secondary device.
Device	getByUuid(String uuid)	Gets the specified device.
PaginatedList<Device>	list()	Lists available Network Edge devices.
PaginatedList<Device>	list(RequestBuilder.Device requestBuilder)	Lists Network Edge devices based on the parameters provided.
PaginatedList<DeviceType>	listDeviceTypes()	Lists the available device types.
List<NetworkInterface>	listInterfaces(String uuid)	Lists the interfaces for the specified device.
String	postLicenseFile(MetroCode metroCode, String deviceTypeCode, LicenseType licenseType, String fileContents)	Posts a new license file.

Method Details

list

PaginatedList<Device> list()

Lists available Network Edge devices.

Returns:

PaginatedList

list

PaginatedList<Device> list(RequestBuilder.Device requestBuilder)

Lists Network Edge devices based on the parameters provided.

Parameters:

requestBuilder - the desired query parameters.

Returns:

PaginatedList

getByUuid

Device getByUuid(String uuid)

Gets the specified device.

Parameters:

uuid - the unique identifier of the device.

Returns:

Device

listDeviceTypes

PaginatedList<DeviceType> listDeviceTypes()

Lists the available device types.

Returns:

PaginatedList

listInterfaces

List<NetworkInterface> listInterfaces(String uuid)

Lists the interfaces for the specified device.

Parameters:

uuid - the unique identifier of the device.

Returns:

List

define

DeviceOperator.DeviceBuilder define(String deviceName)

Returns an instance of DeviceBuilder for defining a new device.

Parameters:

deviceName - a String object.

Returns:

DeviceOperator.DeviceBuilder

defineSecondary

DeviceOperator.DeviceBuilderSecondary defineSecondary(String secondaryDeviceName,
 String primaryDeviceUuid)

Returns an instance of DeviceBuilderSecondary for defining a secondary device.

Parameters:

secondaryDeviceName - a String object.

primaryDeviceUuid - a String object.

Returns:

DeviceOperator.DeviceBuilderSecondary

postLicenseFile

String postLicenseFile(MetroCode metroCode,
 String deviceTypeCode,
 LicenseType licenseType,
 String fileContents)

Posts a new license file.

Parameters:

metroCode - the MetroCode to associate the license file with.

deviceTypeCode - the device type code to associate the license file with.

licenseType - the LicenseType to associate the license file with.

fileContents - the contents of the license file.

Returns:

String the fileId of the uploaded license file.