Package api.equinix.javasdk.fabric.client

Interface FabricGateways

All Known Implementing Classes:

FabricGatewaysImpl

public interface FabricGateways

Client interface for managing Equinix Fabric Gateways. Gateways provide virtual routing and network functions for connecting to cloud providers and other networks.

Method Summary

Modifier and Type	Method	Description
GatewayPackage	gatewayPackageByCode(GatewayPackageCode gatewayPackageCode)	Retrieves a specific gateway package by its package code.
PaginatedList<GatewayPackage>	gatewayPackages()	Lists all available gateway packages.
FabricGateway	getByUuid(String uuid)	Retrieves a single fabric gateway by its unique identifier.
PaginatedFilteredList<FabricGateway>	search()	Searches for fabric gateways using default filter and sort criteria.
PaginatedFilteredList<FabricGateway>	search(FilterPropertyList filter)	Searches for fabric gateways matching the specified filter criteria.
PaginatedFilteredList<FabricGateway>	search(FilterPropertyList filter, SortPropertyList sort)	Searches for fabric gateways matching the specified filter and sort criteria.
PaginatedFilteredList<FabricGateway>	search(SortPropertyList sort)	Searches for fabric gateways with the specified sort order.

Method Details

search

PaginatedFilteredList<FabricGateway> search()

Searches for fabric gateways using default filter and sort criteria.

Returns:

a paginated, filtered list of matching gateways

search

PaginatedFilteredList<FabricGateway> search(FilterPropertyList filter)

Searches for fabric gateways matching the specified filter criteria.

Parameters:

filter - the filter criteria to apply

Returns:

a paginated, filtered list of matching gateways

search

PaginatedFilteredList<FabricGateway> search(SortPropertyList sort)

Searches for fabric gateways with the specified sort order.

Parameters:

sort - the sort criteria to apply

Returns:

a paginated, filtered list of matching gateways

search

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

Searches for fabric gateways 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 gateways

getByUuid

FabricGateway getByUuid(String uuid)

Retrieves a single fabric gateway by its unique identifier.

Parameters:

uuid - the unique identifier of the gateway

Returns:

the fabric gateway matching the given UUID

gatewayPackages

PaginatedList<GatewayPackage> gatewayPackages()

Lists all available gateway packages.

Returns:

a paginated list of gateway packages

gatewayPackageByCode

GatewayPackage gatewayPackageByCode(GatewayPackageCode gatewayPackageCode)

Retrieves a specific gateway package by its package code.

Parameters:

gatewayPackageCode - the code identifying the gateway package

Returns:

the gateway package matching the given code