Interface OpticalConnects

All Known Implementing Classes:
OpticalConnectsImpl
@Beta public interface OpticalConnects
Optical Metro Connect services (4 operations).

Obtain it from fabric.beta().opticalConnects(). Every operation maps one Fabric v4 endpoint; the Javadoc of each method names the path and the spec operation id.

Beta: Fabric v4 4.34.0 (spec read 2026-11-11).

Generated from the Fabric v4 OpenAPI spec by the fabric-beta generator; regenerate rather than hand-edit.

  • Method Details

    • create

      OpticalConnectResponse create(OpticalConnectPostRequest request)
      Create Optical Metro Connect Service: POST /fabric/v4/opticalConnects (operation createOpticalConnect).

      Create a single Optical Metro Connect circuit.

      Parameters:
      request - the OpticalConnectPostRequest request body
      Returns:
      the OpticalConnectResponse the API returns

    • createDiverse

      List<OpticalConnectResponse> createDiverse(BulkOpticalConnectRequest request)
      Create Dual Diverse Optical Metro Connect Service: POST /fabric/v4/opticalConnects/bulk (operation createBulkOpticalConnect).

      Create a dual diverse pair of circuits on separate optical paths.

      Unwraps the OpticalConnectBulk data envelope (the spec documents no paging for it).

      Parameters:
      request - the BulkOpticalConnectRequest request body
      Returns:
      the OpticalConnectResponse entries (empty when none)

    • getByUuid

      OpticalConnectResponse getByUuid(String opticalConnectId)
      Get Optical Metro Connect Service: GET /fabric/v4/opticalConnects/{opticalConnectId} (operation getOpticalConnectByUuid).

      Get a single Optical Metro Connect by UUID.

      Parameters:
      opticalConnectId - the opticalConnectId path parameter
      Returns:
      the OpticalConnectResponse the API returns

    • search

      PaginatedFilteredList<OpticalConnectResponse> search(FilterPropertyList filter, SortPropertyList sort)
      Search Optical Metro Connect Services: POST /fabric/v4/opticalConnects/search (operation searchOpticalConnect).

      Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.

      Filter properties named by the spec: /bandwidth, /name, /state, /type, /uuid.

      Sort properties named by the spec: /aSide/location/ibxCode, /bandwidth, /changeLog/createdDateTime, /changeLog/updatedDateTime, /name, /state, /type, /uuid, /zSide/location/ibxCode.

      Parameters:
      filter - the filter (null for none)
      sort - the sort order (null for the service default)
      Returns:
      a lazily paged list of OpticalConnectResponse

    • search

      PaginatedFilteredList<OpticalConnectResponse> search(FilterPropertyList filter)
      Search Optical Metro Connect Services: POST /fabric/v4/opticalConnects/search (operation searchOpticalConnect).

      Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.

      Parameters:
      filter - the filter (null for none)
      Returns:
      a lazily paged list of OpticalConnectResponse

    • search

      PaginatedFilteredList<OpticalConnectResponse> search()
      Search Optical Metro Connect Services: POST /fabric/v4/opticalConnects/search (operation searchOpticalConnect).

      Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.

      Returns:
      a lazily paged list of OpticalConnectResponse