Package api.equinix.javasdk.fabric.client

Interface Connections

All Known Implementing Classes:

ConnectionsImpl

public interface Connections

Client interface for managing Equinix Fabric connections. Provides operations for searching, retrieving, creating, and monitoring connections between Fabric endpoints.

Version:

$Id: $Id

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
ConnectionOperator.ConnectionBuilder	define(ConnectionType connectionType)	Begins the fluent builder for creating a new connection.
Connection	getByUuid(String uuid)	Retrieves a single connection by its unique identifier.
ConnectionStatistic	getStatistics(String uuid, LocalDateTime startDateTime, LocalDateTime endDateTime)	Retrieves bandwidth statistics for a connection over the specified time range.
ConnectionStatistic	getStatistics(String uuid, LocalDateTime startDateTime, LocalDateTime endDateTime, Side viewPoint)	Retrieves bandwidth statistics for a connection over the specified time range, viewed from a specific side.
PaginatedFilteredList<Connection>	search()	Searches for connections using default filter and sort criteria.
PaginatedFilteredList<Connection>	search(FilterPropertyList filter)	Searches for connections matching the specified filter criteria.
PaginatedFilteredList<Connection>	search(FilterPropertyList filter, SortPropertyList sort)	Searches for connections matching the specified filter and sort criteria.
PaginatedFilteredList<Connection>	search(SortPropertyList sort)	Searches for connections with the specified sort order.
ConnectionOperator.BatchConnectionBuilder	startBatch()	Begins a batch builder for creating multiple connections in a single request.

Method Details

search

PaginatedFilteredList<Connection> search()

Searches for connections using default filter and sort criteria.

Returns:

a paginated, filtered list of matching connections

search

PaginatedFilteredList<Connection> search(FilterPropertyList filter)

Searches for connections matching the specified filter criteria.

Parameters:

filter - the filter criteria to apply

Returns:

a paginated, filtered list of matching connections

search

PaginatedFilteredList<Connection> search(SortPropertyList sort)

Searches for connections with the specified sort order.

Parameters:

sort - the sort criteria to apply

Returns:

a paginated, filtered list of matching connections

search

PaginatedFilteredList<Connection> search(FilterPropertyList filter,
 SortPropertyList sort)

Searches for connections matching the specified filter and sort criteria.

Parameters:

filter - the filter criteria to apply

sort - the sort criteria to apply

Returns:

a paginated, filtered list of matching connections

getByUuid

Connection getByUuid(String uuid)

Retrieves a single connection by its unique identifier.

Parameters:

uuid - the unique identifier of the connection

Returns:

the connection matching the given UUID

define

ConnectionOperator.ConnectionBuilder define(ConnectionType connectionType)

Begins the fluent builder for creating a new connection. Call methods on the returned builder to configure the connection, then call create().

Parameters:

connectionType - the type of connection to create

Returns:

a builder for configuring the new connection

startBatch

ConnectionOperator.BatchConnectionBuilder startBatch()

Begins a batch builder for creating multiple connections in a single request.

Returns:

a batch builder for configuring multiple connections

getStatistics

ConnectionStatistic getStatistics(String uuid,
 LocalDateTime startDateTime,
 LocalDateTime endDateTime,
 Side viewPoint)

Retrieves bandwidth statistics for a connection over the specified time range, viewed from a specific side.

Parameters:

uuid - the unique identifier of the connection

startDateTime - the start of the statistics time range

endDateTime - the end of the statistics time range

viewPoint - the side (A-side or Z-side) from which to view the statistics

Returns:

the connection statistics for the specified time range and viewpoint

getStatistics

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

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

Parameters:

uuid - the unique identifier of the connection

startDateTime - the start of the statistics time range

endDateTime - the end of the statistics time range

Returns:

the connection statistics for the specified time range