Class DataFlowDebugSessionClient
java.lang.Object
com.azure.analytics.synapse.artifacts.DataFlowDebugSessionClient
Initializes a new instance of the synchronous ArtifactsClient type.
-
Method Summary
Modifier and TypeMethodDescriptionaddDataFlow
(DataFlowDebugPackage request) Add a data flow into debug session.addDataFlowWithResponse
(DataFlowDebugPackage request, Context context) Add a data flow into debug session.Creates a data flow debug session.createDataFlowDebugSessionWithResponse
(CreateDataFlowDebugSessionRequest request, Context context) Creates a data flow debug session.void
Deletes a data flow debug session.deleteDataFlowDebugSessionWithResponse
(DeleteDataFlowDebugSessionRequest request, Context context) Deletes a data flow debug session.Execute a data flow debug command.executeCommandWithResponse
(DataFlowDebugCommandRequest request, Context context) Execute a data flow debug command.Query all active data flow debug sessions.Query all active data flow debug sessions.
-
Method Details
-
createDataFlowDebugSession
public CreateDataFlowDebugSessionResponse createDataFlowDebugSession(CreateDataFlowDebugSessionRequest request) Creates a data flow debug session.- Parameters:
request
- Data flow debug session definition.- Returns:
- response body structure for creating data flow debug session.
- 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.
-
createDataFlowDebugSessionWithResponse
public DataFlowDebugSessionsCreateDataFlowDebugSessionResponse createDataFlowDebugSessionWithResponse(CreateDataFlowDebugSessionRequest request, Context context) Creates a data flow debug session.- Parameters:
request
- Data flow debug session definition.context
- The context to associate with this operation.- Returns:
- response body structure for creating data flow debug session.
- 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.
-
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 PagedIterable<DataFlowDebugSessionInfo> queryDataFlowDebugSessionsByWorkspace(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.
-
addDataFlow
Add a data flow into debug session.- Parameters:
request
- Data flow debug session definition with debug content.- Returns:
- response body structure for starting data flow debug session.
- 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 Response<AddDataFlowToDebugSessionResponse> addDataFlowWithResponse(DataFlowDebugPackage request, 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.
-
deleteDataFlowDebugSession
Deletes a data flow debug session.- Parameters:
request
- Data flow debug session definition for deletion.- 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 Response<Void> deleteDataFlowDebugSessionWithResponse(DeleteDataFlowDebugSessionRequest request, 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.
-
executeCommand
Execute a data flow debug command.- Parameters:
request
- Data flow debug command definition.- 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.
-
executeCommandWithResponse
public DataFlowDebugSessionsExecuteCommandResponse executeCommandWithResponse(DataFlowDebugCommandRequest request, 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.
-