Package api.equinix.javasdk.fabric.client

Interface Ports

All Known Implementing Classes:

PortsImpl

public interface Ports

Client interface for managing Equinix Fabric ports. Provides operations for listing, retrieving, and monitoring port bandwidth statistics.

Version:

$Id: $Id

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
Port	getByUuid(String uuid)	Retrieves a single port by its unique identifier.
PortStatistic	getStatistics(String uuid, LocalDateTime startDateTime, LocalDateTime endDateTime)	Retrieves bandwidth statistics for a port over the specified time range.
PaginatedList<PortStatistic>	getTopStatistics(StatisticDuration duration, Sortable sortable)	Retrieves top port statistics ranked by bandwidth usage for the specified duration.
PaginatedList<PortStatistic>	getTopStatistics(StatisticDuration duration, Sortable sortable, RequestBuilder.TopPortStatistics requestBuilder)	Retrieves top port statistics ranked by bandwidth usage with additional request options.
PaginatedList<Port>	list()	Lists all ports accessible to the current account.

Method Details

list

PaginatedList<Port> list()

Lists all ports accessible to the current account.

Returns:

a paginated list of ports

getByUuid

Port getByUuid(String uuid)

Retrieves a single port by its unique identifier.

Parameters:

uuid - the unique identifier of the port

Returns:

the port matching the given UUID

getStatistics

PortStatistic getStatistics(String uuid,
 LocalDateTime startDateTime,
 LocalDateTime endDateTime)

Retrieves bandwidth statistics for a port over the specified time range.

Parameters:

uuid - the unique identifier of the port

startDateTime - the start of the statistics time range

endDateTime - the end of the statistics time range

Returns:

the port statistics for the specified time range

getTopStatistics

PaginatedList<PortStatistic> getTopStatistics(StatisticDuration duration,
 Sortable sortable)

Retrieves top port statistics ranked by bandwidth usage for the specified duration.

Parameters:

duration - the time duration to aggregate statistics over

sortable - the sort configuration for ranking results

Returns:

a paginated list of top port statistics

getTopStatistics

PaginatedList<PortStatistic> getTopStatistics(StatisticDuration duration,
 Sortable sortable,
 RequestBuilder.TopPortStatistics requestBuilder)

Retrieves top port statistics ranked by bandwidth usage with additional request options.

Parameters:

duration - the time duration to aggregate statistics over

sortable - the sort configuration for ranking results

requestBuilder - additional request parameters for filtering top statistics

Returns:

a paginated list of top port statistics