Package com.azure.resourcemanager.datafactory.models

Interface DataFlowDebugSessions

public interface DataFlowDebugSessions

Resource collection API of DataFlowDebugSessions.

Method Summary

Modifier and Type	Method	Description
AddDataFlowToDebugSessionResponse	addDataFlow(String resourceGroupName, String factoryName, DataFlowDebugPackage request)	Add a data flow into debug session.
com.azure.core.http.rest.Response<AddDataFlowToDebugSessionResponse>	addDataFlowWithResponse(String resourceGroupName, String factoryName, DataFlowDebugPackage request, com.azure.core.util.Context context)	Add a data flow into debug session.
CreateDataFlowDebugSessionResponse	create(String resourceGroupName, String factoryName, CreateDataFlowDebugSessionRequest request)	Creates a data flow debug session.
CreateDataFlowDebugSessionResponse	create(String resourceGroupName, String factoryName, CreateDataFlowDebugSessionRequest request, com.azure.core.util.Context context)	Creates a data flow debug session.
void	delete(String resourceGroupName, String factoryName, DeleteDataFlowDebugSessionRequest request)	Deletes a data flow debug session.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, DeleteDataFlowDebugSessionRequest request, com.azure.core.util.Context context)	Deletes a data flow debug session.
DataFlowDebugCommandResponse	executeCommand(String resourceGroupName, String factoryName, DataFlowDebugCommandRequest request)	Execute a data flow debug command.
DataFlowDebugCommandResponse	executeCommand(String resourceGroupName, String factoryName, DataFlowDebugCommandRequest request, com.azure.core.util.Context context)	Execute a data flow debug command.
com.azure.core.http.rest.PagedIterable<DataFlowDebugSessionInfo>	queryByFactory(String resourceGroupName, String factoryName)	Query all active data flow debug sessions.
com.azure.core.http.rest.PagedIterable<DataFlowDebugSessionInfo>	queryByFactory(String resourceGroupName, String factoryName, com.azure.core.util.Context context)	Query all active data flow debug sessions.

Method Detail

create

CreateDataFlowDebugSessionResponse create(String resourceGroupName,
                                          String factoryName,
                                          CreateDataFlowDebugSessionRequest request)

Creates a data flow debug session.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

request - Data flow debug session definition.

Returns:

response body structure for creating data flow debug session.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

create

CreateDataFlowDebugSessionResponse create(String resourceGroupName,
                                          String factoryName,
                                          CreateDataFlowDebugSessionRequest request,
                                          com.azure.core.util.Context context)

Creates a data flow debug session.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

queryByFactory

com.azure.core.http.rest.PagedIterable<DataFlowDebugSessionInfo> queryByFactory(String resourceGroupName,
                                                                                String factoryName)

Query all active data flow debug sessions.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

Returns:

a list of active debug sessions as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

queryByFactory

com.azure.core.http.rest.PagedIterable<DataFlowDebugSessionInfo> queryByFactory(String resourceGroupName,
                                                                                String factoryName,
                                                                                com.azure.core.util.Context context)

Query all active data flow debug sessions.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addDataFlow

AddDataFlowToDebugSessionResponse addDataFlow(String resourceGroupName,
                                              String factoryName,
                                              DataFlowDebugPackage request)

Add a data flow into debug session.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addDataFlowWithResponse

com.azure.core.http.rest.Response<AddDataFlowToDebugSessionResponse> addDataFlowWithResponse(String resourceGroupName,
                                                                                             String factoryName,
                                                                                             DataFlowDebugPackage request,
                                                                                             com.azure.core.util.Context context)

Add a data flow into debug session.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String factoryName,
            DeleteDataFlowDebugSessionRequest request)

Deletes a data flow debug session.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

request - Data flow debug session definition for deletion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String factoryName,
                                                           DeleteDataFlowDebugSessionRequest request,
                                                           com.azure.core.util.Context context)

Deletes a data flow debug session.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

executeCommand

DataFlowDebugCommandResponse executeCommand(String resourceGroupName,
                                            String factoryName,
                                            DataFlowDebugCommandRequest request)

Execute a data flow debug command.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

executeCommand

DataFlowDebugCommandResponse executeCommand(String resourceGroupName,
                                            String factoryName,
                                            DataFlowDebugCommandRequest request,
                                            com.azure.core.util.Context context)

Execute a data flow debug command.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.