Class LinkConnectionClient

java.lang.Object
com.azure.analytics.synapse.artifacts.LinkConnectionClient

public final class LinkConnectionClient extends Object
Initializes a new instance of the synchronous ArtifactsClient type.
  • Method Details

    • listLinkConnectionsByWorkspace

      public com.azure.core.http.rest.PagedIterable<LinkConnectionResource> listLinkConnectionsByWorkspace()
      List link connections.
      Returns:
      the paginated response with PagedIterable.
      Throws:
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listLinkConnectionsByWorkspace

      public com.azure.core.http.rest.PagedIterable<LinkConnectionResource> listLinkConnectionsByWorkspace(com.azure.core.util.Context context)
      List link connections.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdateLinkConnection

      public LinkConnectionResource createOrUpdateLinkConnection(String linkConnectionName, LinkConnectionResource linkConnection)
      Creates or updates a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      linkConnection - Link connection resource definition.
      Returns:
      the response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdateLinkConnectionWithResponse

      public com.azure.core.http.rest.Response<LinkConnectionResource> createOrUpdateLinkConnectionWithResponse(String linkConnectionName, LinkConnectionResource linkConnection, com.azure.core.util.Context context)
      Creates or updates a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      linkConnection - Link connection resource definition.
      context - The context to associate with this operation.
      Returns:
      the response body along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getLinkConnection

      public LinkConnectionResource getLinkConnection(String linkConnectionName)
      Get a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      Returns:
      a link connection.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getLinkConnectionWithResponse

      public com.azure.core.http.rest.Response<LinkConnectionResource> getLinkConnectionWithResponse(String linkConnectionName, com.azure.core.util.Context context)
      Get a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      context - The context to associate with this operation.
      Returns:
      a link connection along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteLinkConnection

      public void deleteLinkConnection(String linkConnectionName)
      Delete a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteLinkConnectionWithResponse

      public com.azure.core.http.rest.Response<Void> deleteLinkConnectionWithResponse(String linkConnectionName, com.azure.core.util.Context context)
      Delete a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • editTables

      public void editTables(String linkConnectionName, EditTablesRequest editTablesRequest)
      Edit tables for a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      editTablesRequest - Edit tables request.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • editTablesWithResponse

      public com.azure.core.http.rest.Response<Void> editTablesWithResponse(String linkConnectionName, EditTablesRequest editTablesRequest, com.azure.core.util.Context context)
      Edit tables for a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      editTablesRequest - Edit tables request.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • start

      public void start(String linkConnectionName)
      Start a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • startWithResponse

      public com.azure.core.http.rest.Response<Void> startWithResponse(String linkConnectionName, com.azure.core.util.Context context)
      Start a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stop

      public void stop(String linkConnectionName)
      Stop a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stopWithResponse

      public com.azure.core.http.rest.Response<Void> stopWithResponse(String linkConnectionName, com.azure.core.util.Context context)
      Stop a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getDetailedStatus

      public LinkConnectionDetailedStatus getDetailedStatus(String linkConnectionName)
      Get the detailed status of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      Returns:
      the detailed status of a link connection.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getDetailedStatusWithResponse

      public com.azure.core.http.rest.Response<LinkConnectionDetailedStatus> getDetailedStatusWithResponse(String linkConnectionName, com.azure.core.util.Context context)
      Get the detailed status of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      context - The context to associate with this operation.
      Returns:
      the detailed status of a link connection along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listLinkTables

      public LinkTableListResponse listLinkTables(String linkConnectionName)
      List the link tables of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      Returns:
      the response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listLinkTablesWithResponse

      public com.azure.core.http.rest.Response<LinkTableListResponse> listLinkTablesWithResponse(String linkConnectionName, com.azure.core.util.Context context)
      List the link tables of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      context - The context to associate with this operation.
      Returns:
      the response body along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • queryTableStatus

      public LinkConnectionQueryTableStatus queryTableStatus(String linkConnectionName, QueryTableStatusRequest queryTableStatusRequest)
      Query the link table status of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      queryTableStatusRequest - Query table status request.
      Returns:
      the response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • queryTableStatusWithResponse

      public com.azure.core.http.rest.Response<LinkConnectionQueryTableStatus> queryTableStatusWithResponse(String linkConnectionName, QueryTableStatusRequest queryTableStatusRequest, com.azure.core.util.Context context)
      Query the link table status of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      queryTableStatusRequest - Query table status request.
      context - The context to associate with this operation.
      Returns:
      the response body along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • updateLandingZoneCredential

      public void updateLandingZoneCredential(String linkConnectionName, UpdateLandingZoneCredential updateLandingZoneCredentialRequest)
      Update landing zone credential of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      updateLandingZoneCredentialRequest - update landing zone credential request.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • updateLandingZoneCredentialWithResponse

      public com.azure.core.http.rest.Response<Void> updateLandingZoneCredentialWithResponse(String linkConnectionName, UpdateLandingZoneCredential updateLandingZoneCredentialRequest, com.azure.core.util.Context context)
      Update landing zone credential of a link connection.
      Parameters:
      linkConnectionName - The link connection name.
      updateLandingZoneCredentialRequest - update landing zone credential request.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.