Package com.azure.resourcemanager.datafactory.models

Interface DataFlows

public interface DataFlows

Resource collection API of DataFlows.

Method Summary

Modifier and Type	Method	Description
DataFlowResource.DefinitionStages.Blank	define(String name)	Begins definition for a new DataFlowResource resource.
void	delete(String resourceGroupName, String factoryName, String dataFlowName)	Deletes a data flow.
void	deleteById(String id)	Deletes a data flow.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a data flow.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, String dataFlowName, com.azure.core.util.Context context)	Deletes a data flow.
DataFlowResource	get(String resourceGroupName, String factoryName, String dataFlowName)	Gets a data flow.
DataFlowResource	getById(String id)	Gets a data flow.
com.azure.core.http.rest.Response<DataFlowResource>	getByIdWithResponse(String id, String ifNoneMatch, com.azure.core.util.Context context)	Gets a data flow.
com.azure.core.http.rest.Response<DataFlowResource>	getWithResponse(String resourceGroupName, String factoryName, String dataFlowName, String ifNoneMatch, com.azure.core.util.Context context)	Gets a data flow.
com.azure.core.http.rest.PagedIterable<DataFlowResource>	listByFactory(String resourceGroupName, String factoryName)	Lists data flows.
com.azure.core.http.rest.PagedIterable<DataFlowResource>	listByFactory(String resourceGroupName, String factoryName, com.azure.core.util.Context context)	Lists data flows.

Method Detail

get

DataFlowResource get(String resourceGroupName,
                     String factoryName,
                     String dataFlowName)

Gets a data flow.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

dataFlowName - The data flow name.

Returns:

a data flow.

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.

getWithResponse

com.azure.core.http.rest.Response<DataFlowResource> getWithResponse(String resourceGroupName,
                                                                    String factoryName,
                                                                    String dataFlowName,
                                                                    String ifNoneMatch,
                                                                    com.azure.core.util.Context context)

Gets a data flow.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

dataFlowName - The data flow name.

ifNoneMatch - ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

a data flow 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,
            String dataFlowName)

Deletes a data flow.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

dataFlowName - The data flow name.

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,
                                                           String dataFlowName,
                                                           com.azure.core.util.Context context)

Deletes a data flow.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

dataFlowName - The data flow name.

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.

listByFactory

com.azure.core.http.rest.PagedIterable<DataFlowResource> listByFactory(String resourceGroupName,
                                                                       String factoryName)

Lists data flows.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

Returns:

a list of data flow resources 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.

listByFactory

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

Lists data flows.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

context - The context to associate with this operation.

Returns:

a list of data flow resources 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.

getById

DataFlowResource getById(String id)

Gets a data flow.

Parameters:

id - the resource ID.

Returns:

a data flow 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.

getByIdWithResponse

com.azure.core.http.rest.Response<DataFlowResource> getByIdWithResponse(String id,
                                                                        String ifNoneMatch,
                                                                        com.azure.core.util.Context context)

Gets a data flow.

Parameters:

id - the resource ID.

ifNoneMatch - ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

a data flow 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.

deleteById

void deleteById(String id)

Deletes a data flow.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes a data flow.

Parameters:

id - the resource ID.

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.

define

DataFlowResource.DefinitionStages.Blank define(String name)

Begins definition for a new DataFlowResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DataFlowResource definition.