Package com.azure.analytics.synapse.artifacts

Class DataFlowClient

java.lang.Object
com.azure.analytics.synapse.artifacts.DataFlowClient
public final class DataFlowClient extends Object
Initializes a new instance of the synchronous ArtifactsClient type.

  • Method Details

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

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

    • createOrUpdateDataFlowWithResponse

      public com.azure.core.http.rest.Response<DataFlowResource> createOrUpdateDataFlowWithResponse(String dataFlowName, DataFlowResource dataFlow, String ifMatch, com.azure.core.util.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.
      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.

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

    • getDataFlow

      public DataFlowResource getDataFlow(String dataFlowName)
      Gets a data flow.
      Parameters:
      dataFlowName - The data flow name.
      Returns:
      a data flow.
      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.

    • getDataFlowWithResponse

      public com.azure.core.http.rest.Response<DataFlowResource> getDataFlowWithResponse(String dataFlowName, String ifNoneMatch, com.azure.core.util.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.
      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.

    • deleteDataFlow

      public void deleteDataFlow(String dataFlowName)
      Deletes a data flow.
      Parameters:
      dataFlowName - The data flow name.
      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.

    • deleteDataFlowWithResponse

      public com.azure.core.http.rest.Response<Void> deleteDataFlowWithResponse(String dataFlowName, com.azure.core.util.Context context)
      Deletes a data flow.
      Parameters:
      dataFlowName - The data flow name.
      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.

    • renameDataFlow

      public void renameDataFlow(String dataFlowName, ArtifactRenameRequest request)
      Renames a dataflow.
      Parameters:
      dataFlowName - The data flow name.
      request - proposed new name.
      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.

    • renameDataFlowWithResponse

      public com.azure.core.http.rest.Response<Void> renameDataFlowWithResponse(String dataFlowName, ArtifactRenameRequest request, com.azure.core.util.Context context)
      Renames a dataflow.
      Parameters:
      dataFlowName - The data flow name.
      request - proposed new name.
      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.

    • getDataFlowsByWorkspace

      public com.azure.core.http.rest.PagedIterable<DataFlowResource> getDataFlowsByWorkspace()
      Lists data flows.
      Returns:
      a list of data flow resources 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.

    • getDataFlowsByWorkspace

      public com.azure.core.http.rest.PagedIterable<DataFlowResource> getDataFlowsByWorkspace(com.azure.core.util.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.
      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.