Interface Metros

All Known Implementing Classes:
MetrosImpl
public interface Metros
Client interface for querying Equinix Fabric metro locations. Metros represent geographic data center regions where Fabric resources can be provisioned.
Author:
ianjones

  • Method Details

    • list

      PaginatedList<Metro> list()
      Lists all available Equinix metro locations.
      Returns:
      a paginated list of metros

    • list

      PaginatedList<Metro> list(MetroPresence presence)
      Lists metro locations filtered by the specified presence type.
      Parameters:
      presence - the presence type to filter metros by (e.g., available for connections)
      Returns:
      a paginated list of metros matching the presence filter

    • getByMetroCode

      Metro getByMetroCode(MetroCode metroCode)
      Retrieves a single metro by its metro code.
      Parameters:
      metroCode - the code identifying the metro location (e.g., SV, DC, AM)
      Returns:
      the metro matching the given code

    • getByMetroCode

      Metro getByMetroCode(String metroCode)
      Retrieves a single metro by its raw metro code string. Use this for a metro not listed by the MetroCode enum (e.g. one added after this SDK was built).
      Parameters:
      metroCode - the code identifying the metro location (e.g., "SV")
      Returns:
      the metro matching the given code

    • getByMetroId

      Metro getByMetroId(MetroId metroId)
      Retrieves a single metro by its MetroId.
      Parameters:
      metroId - the forward-compatible identifier of the metro location
      Returns:
      the metro matching the given id