DataFlowClient Class

Package:
com.azure.analytics.synapse.artifacts
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17
  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.DataFlowClient

public final class DataFlowClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type Method and Description
DataFlowResource createOrUpdateDataFlow(String dataFlowName, DataFlowResource dataFlow)

Creates or updates a data flow.
DataFlowResource createOrUpdateDataFlow(String dataFlowName, DataFlowResource dataFlow, String ifMatch)

Creates or updates a data flow.
Response<DataFlowResource> createOrUpdateDataFlowWithResponse(String dataFlowName, DataFlowResource dataFlow, String ifMatch, Context context)

Creates or updates a data flow.
void deleteDataFlow(String dataFlowName)

Deletes a data flow.
Response<Void> deleteDataFlowWithResponse(String dataFlowName, Context context)

Deletes a data flow.
DataFlowResource getDataFlow(String dataFlowName)

Gets a data flow.
DataFlowResource getDataFlow(String dataFlowName, String ifNoneMatch)

Gets a data flow.
PagedIterable<DataFlowResource> getDataFlowsByWorkspace()

Lists data flows.
PagedIterable<DataFlowResource> getDataFlowsByWorkspace(Context context)

Lists data flows.
Response<DataFlowResource> getDataFlowWithResponse(String dataFlowName, String ifNoneMatch, Context context)

Gets a data flow.
void renameDataFlow(String dataFlowName, ArtifactRenameRequest request)

Renames a dataflow.
Response<Void> renameDataFlowWithResponse(String dataFlowName, ArtifactRenameRequest request, Context context)

Renames a dataflow.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdateDataFlow

public DataFlowResource createOrUpdateDataFlow(String dataFlowName, DataFlowResource dataFlow)

Creates or updates a data flow.

Parameters:

dataFlowName - The data flow name.
dataFlow - Data flow resource definition.

Returns:

data flow resource type.

createOrUpdateDataFlow

public DataFlowResource createOrUpdateDataFlow(String dataFlowName, DataFlowResource dataFlow, String ifMatch)

Creates or updates a data flow.

Parameters:

dataFlowName - The data flow name.
dataFlow - Data flow resource definition.
ifMatch - ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

data flow resource type.

createOrUpdateDataFlowWithResponse

public Response<DataFlowResource> createOrUpdateDataFlowWithResponse(String dataFlowName, DataFlowResource dataFlow, String ifMatch, Context context)

Creates or updates a data flow.

Parameters:

dataFlowName - The data flow name.
dataFlow - Data flow resource definition.
ifMatch - ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
context - The context to associate with this operation.

Returns:

data flow resource type along with Response<T>.

deleteDataFlow

public void deleteDataFlow(String dataFlowName)

Deletes a data flow.

Parameters:

dataFlowName - The data flow name.

deleteDataFlowWithResponse

public Response<Void> deleteDataFlowWithResponse(String dataFlowName, Context context)

Deletes a data flow.

Parameters:

dataFlowName - The data flow name.
context - The context to associate with this operation.

Returns:

getDataFlow

public DataFlowResource getDataFlow(String dataFlowName)

Gets a data flow.

Parameters:

dataFlowName - The data flow name.

Returns:

a data flow.

getDataFlow

public DataFlowResource getDataFlow(String dataFlowName, String ifNoneMatch)

Gets a data flow.

Parameters:

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.

Returns:

a data flow.

getDataFlowsByWorkspace

public PagedIterable<DataFlowResource> getDataFlowsByWorkspace()

Lists data flows.

Returns:

a list of data flow resources as paginated response with PagedIterable<T>.

getDataFlowsByWorkspace

public PagedIterable<DataFlowResource> getDataFlowsByWorkspace(Context context)

Lists data flows.

Parameters:

context - The context to associate with this operation.

Returns:

a list of data flow resources as paginated response with PagedIterable<T>.

getDataFlowWithResponse

public Response<DataFlowResource> getDataFlowWithResponse(String dataFlowName, String ifNoneMatch, Context context)

Gets a data flow.

Parameters:

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<T>.

renameDataFlow

public void renameDataFlow(String dataFlowName, ArtifactRenameRequest request)

Renames a dataflow.

Parameters:

dataFlowName - The data flow name.
request - proposed new name.

renameDataFlowWithResponse

public Response<Void> renameDataFlowWithResponse(String dataFlowName, ArtifactRenameRequest request, Context context)

Renames a dataflow.

Parameters:

dataFlowName - The data flow name.
request - proposed new name.
context - The context to associate with this operation.

Returns:

Applies to