Package com.azure.analytics.synapse.artifacts

Class DataFlowDebugSessionClient

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

    • Method Detail

      • queryDataFlowDebugSessionsByWorkspace

        public com.azure.core.http.rest.PagedIterable<DataFlowDebugSessionInfo> queryDataFlowDebugSessionsByWorkspace()
        Query all active data flow debug sessions.
        Returns:
        a list of active debug sessions as 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.

      • queryDataFlowDebugSessionsByWorkspace

        public com.azure.core.http.rest.PagedIterable<DataFlowDebugSessionInfo> queryDataFlowDebugSessionsByWorkspace​(com.azure.core.util.Context context)
        Query all active data flow debug sessions.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        a list of active debug sessions as 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.

      • addDataFlowWithResponse

        public com.azure.core.http.rest.Response<AddDataFlowToDebugSessionResponse> addDataFlowWithResponse​(DataFlowDebugPackage request,
                                                                                                    com.azure.core.util.Context context)
        Add a data flow into debug session.
        Parameters:
        request - Data flow debug session definition with debug content.
        context - The context to associate with this operation.
        Returns:
        response body structure for starting data flow debug session 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.

      • deleteDataFlowDebugSessionWithResponse

        public com.azure.core.http.rest.Response<Void> deleteDataFlowDebugSessionWithResponse​(DeleteDataFlowDebugSessionRequest request,
                                                                                      com.azure.core.util.Context context)
        Deletes a data flow debug session.
        Parameters:
        request - Data flow debug session definition for deletion.
        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.

      • executeCommandWithResponse

        public DataFlowDebugSessionsExecuteCommandResponse executeCommandWithResponse​(DataFlowDebugCommandRequest request,
                                                                              com.azure.core.util.Context context)
        Execute a data flow debug command.
        Parameters:
        request - Data flow debug command definition.
        context - The context to associate with this operation.
        Returns:
        response body structure of data flow result for data preview, statistics or expression preview.
        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.