Interface AppLinks

All Known Implementing Classes:
AppLinksImpl
@Beta public interface AppLinks
Application Connect links and their domain, service and processor attachments (21 operations).

Obtain it from fabric.beta().appLinks(). 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

      AppLink create(AppLinkPostRequest request)
      Create Link: POST /fabric/v4/appLinks (operation createAppLink).

      This API provides capability to create user's Link

      Parameters:
      request - the AppLinkPostRequest request body
      Returns:
      the AppLink the API returns

    • getByUuid

      AppLink getByUuid(String appLinkId)
      Get Link: GET /fabric/v4/appLinks/{appLinkId} (operation getAppLinkByUuid).

      This API provides capability to retrieve user's Link

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      the AppLink the API returns

    • delete

      AppLink delete(String appLinkId)
      Delete Link: DELETE /fabric/v4/appLinks/{appLinkId} (operation deleteAppLinkByUuid).

      This API provides capability to delete user's Link

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      the AppLink the API returns

    • update

      AppLink update(String appLinkId, List<PatchOperation> operations)
      Update Link: PATCH /fabric/v4/appLinks/{appLinkId} (operation updateAppLinkByUuid).

      This API provides capability to update user's Link

      Sent as application/json-patch+json, per the spec. Patchable paths named by the spec: /bandwidth, /description, /ipv4Subnet, /name.

      Parameters:
      appLinkId - the appLinkId path parameter
      operations - the patch operations (op/path/value)
      Returns:
      the AppLink the API returns

    • search

      PaginatedFilteredList<AppLink> search(FilterPropertyList filter, SortPropertyList sort)
      Search Links: POST /fabric/v4/appLinks/search (operation searchAppLinks).

      The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting

      Filter properties named by the spec: /bandwidth, /changeLog/createdDateTime, /changeLog/deletedDateTime, /changeLog/updatedDateTime, /description, /ipv4Subnet, /name, /project/projectId, /state, /uuid.

      Sort properties named by the spec: /changeLog/createdDateTime, /changeLog/updatedDateTime, /name, /state, /uuid.

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

    • search

      PaginatedFilteredList<AppLink> search(FilterPropertyList filter)
      Search Links: POST /fabric/v4/appLinks/search (operation searchAppLinks).

      The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting

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

    • search

      PaginatedFilteredList<AppLink> search()
      Search Links: POST /fabric/v4/appLinks/search (operation searchAppLinks).

      The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting

      Returns:
      a lazily paged list of AppLink

    • attachAppDomain

      AppLinkAppDomainAttachment attachAppDomain(String appLinkId, String appDomainId)
      Attach Domain to Link: PUT /fabric/v4/appLinks/{appLinkId}/appDomains/{appDomainId} (operation attachAppDomainToAppLink).

      This API provides ability to attach the user's App Domain to App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      appDomainId - the appDomainId path parameter
      Returns:
      the AppLinkAppDomainAttachment the API returns

    • detachAppDomain

      AppLinkAppDomainAttachment detachAppDomain(String appLinkId, String appDomainId)
      Detach Domain from Link: DELETE /fabric/v4/appLinks/{appLinkId}/appDomains/{appDomainId} (operation detachAppDomainFromAppLink).

      This API provides ability to detach App Domain from App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      appDomainId - the appDomainId path parameter
      Returns:
      the AppLinkAppDomainAttachment the API returns

    • getAttachedAppDomain

      AppLinkAppDomainAttachment getAttachedAppDomain(String appLinkId, String appDomainId)
      Get Attached Domain for Link: GET /fabric/v4/appLinks/{appLinkId}/appDomains/{appDomainId} (operation getAttachedAppDomainByUuid).

      This API provides ability to retrieve an App Domain attached to an App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      appDomainId - the appDomainId path parameter
      Returns:
      the AppLinkAppDomainAttachment the API returns

    • searchAttachedAppDomains

      PaginatedFilteredList<AppLinkAppDomainAttachment> searchAttachedAppDomains(String appLinkId, FilterPropertyList filter, SortPropertyList sort)
      Search Attached Domains for Link: POST /fabric/v4/appLinks/{appLinkId}/appDomains/search (operation searchAttachedAppDomains).

      The API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting

      Filter properties named by the spec: /attachmentStatus, /uuid.

      Sort properties named by the spec: /attachmentStatus, /changeLog/createdDateTime, /changeLog/updatedDateTime, /uuid.

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

    • searchAttachedAppDomains

      PaginatedFilteredList<AppLinkAppDomainAttachment> searchAttachedAppDomains(String appLinkId, FilterPropertyList filter)
      Search Attached Domains for Link: POST /fabric/v4/appLinks/{appLinkId}/appDomains/search (operation searchAttachedAppDomains).

      The API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting

      Parameters:
      appLinkId - the appLinkId path parameter
      filter - the filter (null for none)
      Returns:
      a lazily paged list of AppLinkAppDomainAttachment

    • searchAttachedAppDomains

      PaginatedFilteredList<AppLinkAppDomainAttachment> searchAttachedAppDomains(String appLinkId)
      Search Attached Domains for Link: POST /fabric/v4/appLinks/{appLinkId}/appDomains/search (operation searchAttachedAppDomains).

      The API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      a lazily paged list of AppLinkAppDomainAttachment

    • listAttachedAppDomains

      PaginatedList<AppLinkAttachedAppDomain> listAttachedAppDomains(String appLinkId, AttachmentQuery query)
      Get Attached Domains for Link: GET /fabric/v4/appLinks/{appLinkId}/appDomains (operation getAttachedAppDomainsByAppLinkId).

      This API provides capability to retrieve App Domains attached to an App Link

      Paged with offset/limit; attachmentStatus filters by state.

      Parameters:
      appLinkId - the appLinkId path parameter
      query - optional attachmentStatus/order/style query parameters (null for none)
      Returns:
      a lazily paged list of AppLinkAttachedAppDomain

    • listAttachedAppDomains

      PaginatedList<AppLinkAttachedAppDomain> listAttachedAppDomains(String appLinkId)
      Get Attached Domains for Link: GET /fabric/v4/appLinks/{appLinkId}/appDomains (operation getAttachedAppDomainsByAppLinkId).

      This API provides capability to retrieve App Domains attached to an App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      a lazily paged list of AppLinkAttachedAppDomain

    • attachAppService

      AppLinkAppServiceAttachment attachAppService(String appLinkId, String appServiceId, AppLinkAttachServiceRequest request)
      Attach Service to Link: PUT /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId} (operation attachAppServiceToAppLink).

      This API provides ability to attach the user's App Service to App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      appServiceId - the appServiceId path parameter
      request - the AppLinkAttachServiceRequest request body
      Returns:
      the AppLinkAppServiceAttachment the API returns

    • detachAppService

      AppLinkAppServiceAttachment detachAppService(String appLinkId, String appServiceId)
      Detach Service from Link: DELETE /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId} (operation detachAppServiceFromAppLink).

      This API provides ability to detach App Service from App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      appServiceId - the appServiceId path parameter
      Returns:
      the AppLinkAppServiceAttachment the API returns

    • updateAppServiceAttachment

      AppLinkAppServiceAttachment updateAppServiceAttachment(String appLinkId, String appServiceId, List<PatchOperation> operations)
      Update Service Attachment for Link: PATCH /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId} (operation updateAppServiceAttachmentToAppLink).

      This API provides ability to update the App Service attachment to App Link

      Sent as application/json-patch+json, per the spec. Patchable paths named by the spec: /destinationIp.

      Parameters:
      appLinkId - the appLinkId path parameter
      appServiceId - the appServiceId path parameter
      operations - the patch operations (op/path/value)
      Returns:
      the AppLinkAppServiceAttachment the API returns

    • getAttachedAppService

      AppLinkAppServiceAttachment getAttachedAppService(String appLinkId, String appServiceId)
      Get Attached Service for Link: GET /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId} (operation getAttachedAppServiceByUuid).

      This API provides ability to retrieve an App Service attached to an App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      appServiceId - the appServiceId path parameter
      Returns:
      the AppLinkAppServiceAttachment the API returns

    • searchAttachedAppServices

      PaginatedFilteredList<AppLinkAppServiceAttachment> searchAttachedAppServices(String appLinkId, FilterPropertyList filter, SortPropertyList sort)
      Search Attached Services for Link: POST /fabric/v4/appLinks/{appLinkId}/appServices/search (operation searchAttachedAppServices).

      The API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting

      Filter properties named by the spec: /attachmentStatus, /uuid.

      Sort properties named by the spec: /attachmentStatus, /changeLog/createdDateTime, /changeLog/updatedDateTime, /uuid.

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

    • searchAttachedAppServices

      PaginatedFilteredList<AppLinkAppServiceAttachment> searchAttachedAppServices(String appLinkId, FilterPropertyList filter)
      Search Attached Services for Link: POST /fabric/v4/appLinks/{appLinkId}/appServices/search (operation searchAttachedAppServices).

      The API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting

      Parameters:
      appLinkId - the appLinkId path parameter
      filter - the filter (null for none)
      Returns:
      a lazily paged list of AppLinkAppServiceAttachment

    • searchAttachedAppServices

      PaginatedFilteredList<AppLinkAppServiceAttachment> searchAttachedAppServices(String appLinkId)
      Search Attached Services for Link: POST /fabric/v4/appLinks/{appLinkId}/appServices/search (operation searchAttachedAppServices).

      The API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      a lazily paged list of AppLinkAppServiceAttachment

    • listAttachedAppServices

      PaginatedList<AppLinkAttachedAppService> listAttachedAppServices(String appLinkId, AttachmentQuery query)
      Get Attached Services for Link: GET /fabric/v4/appLinks/{appLinkId}/appServices (operation getAttachedAppServicesByAppLinkId).

      This API provides capability to retrieve App Services attached to an App Link

      Paged with offset/limit; attachmentStatus filters by state.

      Parameters:
      appLinkId - the appLinkId path parameter
      query - optional attachmentStatus/order/style query parameters (null for none)
      Returns:
      a lazily paged list of AppLinkAttachedAppService

    • listAttachedAppServices

      PaginatedList<AppLinkAttachedAppService> listAttachedAppServices(String appLinkId)
      Get Attached Services for Link: GET /fabric/v4/appLinks/{appLinkId}/appServices (operation getAttachedAppServicesByAppLinkId).

      This API provides capability to retrieve App Services attached to an App Link

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      a lazily paged list of AppLinkAttachedAppService

    • attachAppProcessor

      AppLinkAppProcessorAttachment attachAppProcessor(String appLinkId, String appProcessorId, AppLinkAttachProcessorRequest request)
      Attach Processor to Link: PUT /fabric/v4/appLinks/{appLinkId}/appProcessors/{appProcessorId} (operation attachAppProcessorToAppLink).

      This API provides ability to attach an App Processor to an App Link.

      Parameters:
      appLinkId - the appLinkId path parameter
      appProcessorId - the appProcessorId path parameter
      request - the AppLinkAttachProcessorRequest request body
      Returns:
      the AppLinkAppProcessorAttachment the API returns

    • detachAppProcessor

      AppLinkAppProcessorAttachment detachAppProcessor(String appLinkId, String appProcessorId)
      Detach App Processor from App Link: DELETE /fabric/v4/appLinks/{appLinkId}/appProcessors/{appProcessorId} (operation detachAppProcessorFromAppLink).

      This API provides ability to detach an App Processor from an App Link.

      Parameters:
      appLinkId - the appLinkId path parameter
      appProcessorId - the appProcessorId path parameter
      Returns:
      the AppLinkAppProcessorAttachment the API returns

    • getAttachedAppProcessor

      AppLinkAppProcessorAttachment getAttachedAppProcessor(String appLinkId, String appProcessorId)
      Get attached App Processor for App Link: GET /fabric/v4/appLinks/{appLinkId}/appProcessors/{appProcessorId} (operation getAttachedAppProcessor).

      This API provides ability to get an App Processor attached to an App Link.

      Parameters:
      appLinkId - the appLinkId path parameter
      appProcessorId - the appProcessorId path parameter
      Returns:
      the AppLinkAppProcessorAttachment the API returns

    • searchAttachedAppProcessors

      PaginatedFilteredList<AppLinkAppProcessorAttachment> searchAttachedAppProcessors(String appLinkId, FilterPropertyList filter, SortPropertyList sort)
      Search attached Processors to Link: POST /fabric/v4/appLinks/{appLinkId}/appProcessors/search (operation searchAttachedAppProcessors).

      The API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting

      Filter properties named by the spec: /attachmentStatus, /uuid.

      Sort properties named by the spec: /attachmentStatus, /changeLog/createdDateTime, /changeLog/updatedDateTime, /uuid.

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

    • searchAttachedAppProcessors

      PaginatedFilteredList<AppLinkAppProcessorAttachment> searchAttachedAppProcessors(String appLinkId, FilterPropertyList filter)
      Search attached Processors to Link: POST /fabric/v4/appLinks/{appLinkId}/appProcessors/search (operation searchAttachedAppProcessors).

      The API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting

      Parameters:
      appLinkId - the appLinkId path parameter
      filter - the filter (null for none)
      Returns:
      a lazily paged list of AppLinkAppProcessorAttachment

    • searchAttachedAppProcessors

      PaginatedFilteredList<AppLinkAppProcessorAttachment> searchAttachedAppProcessors(String appLinkId)
      Search attached Processors to Link: POST /fabric/v4/appLinks/{appLinkId}/appProcessors/search (operation searchAttachedAppProcessors).

      The API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      a lazily paged list of AppLinkAppProcessorAttachment

    • listAttachedAppProcessors

      PaginatedList<AppLinkAppProcessorAttachment> listAttachedAppProcessors(String appLinkId, AttachmentQuery query)
      Get attached Processors for Link: GET /fabric/v4/appLinks/{appLinkId}/appProcessors (operation getAttachedAppProcessorsByAppLinkId).

      This API provides capability to retrieve App Processors attached to an App Link.

      Paged with offset/limit; attachmentStatus filters by state.

      Parameters:
      appLinkId - the appLinkId path parameter
      query - optional attachmentStatus/order/style query parameters (null for none)
      Returns:
      a lazily paged list of AppLinkAppProcessorAttachment

    • listAttachedAppProcessors

      PaginatedList<AppLinkAppProcessorAttachment> listAttachedAppProcessors(String appLinkId)
      Get attached Processors for Link: GET /fabric/v4/appLinks/{appLinkId}/appProcessors (operation getAttachedAppProcessorsByAppLinkId).

      This API provides capability to retrieve App Processors attached to an App Link.

      Parameters:
      appLinkId - the appLinkId path parameter
      Returns:
      a lazily paged list of AppLinkAppProcessorAttachment