PipelineClient Class

Package:

com.azure.analytics.synapse.artifacts

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.PipelineClient

public final class PipelineClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method and Description
PipelineResource	createOrUpdatePipeline(String pipelineName, PipelineResource pipeline) Creates or updates a pipeline.
PipelineResource	createOrUpdatePipeline(String pipelineName, PipelineResource pipeline, String ifMatch) Creates or updates a pipeline.
Response<PipelineResource>	createOrUpdatePipelineWithResponse(String pipelineName, PipelineResource pipeline, String ifMatch, Context context) Creates or updates a pipeline.
CreateRunResponse	createPipelineRun(String pipelineName) Creates a run of a pipeline.
CreateRunResponse	createPipelineRun(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String,Object> parameters) Creates a run of a pipeline.
Response<CreateRunResponse>	createPipelineRunWithResponse(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String,Object> parameters, Context context) Creates a run of a pipeline.
void	deletePipeline(String pipelineName) Deletes a pipeline.
Response<Void>	deletePipelineWithResponse(String pipelineName, Context context) Deletes a pipeline.
PipelineResource	getPipeline(String pipelineName) Gets a pipeline.
PipelineResource	getPipeline(String pipelineName, String ifNoneMatch) Gets a pipeline.
Response<PipelineResource>	getPipelineWithResponse(String pipelineName, String ifNoneMatch, Context context) Gets a pipeline.
PagedIterable<PipelineResource>	getPipelinesByWorkspace() Lists pipelines.
PagedIterable<PipelineResource>	getPipelinesByWorkspace(Context context) Lists pipelines.
void	renamePipeline(String pipelineName, ArtifactRenameRequest request) Renames a pipeline.
Response<Void>	renamePipelineWithResponse(String pipelineName, ArtifactRenameRequest request, Context context) Renames a pipeline.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdatePipeline

public PipelineResource createOrUpdatePipeline(String pipelineName, PipelineResource pipeline)

Creates or updates a pipeline.

Parameters:

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

Returns:

pipeline resource type.

createOrUpdatePipeline

public PipelineResource createOrUpdatePipeline(String pipelineName, PipelineResource pipeline, String ifMatch)

Creates or updates a pipeline.

Parameters:

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

ifMatch - ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

pipeline resource type.

createOrUpdatePipelineWithResponse

public Response createOrUpdatePipelineWithResponse(String pipelineName, PipelineResource pipeline, String ifMatch, Context context)

Creates or updates a pipeline.

Parameters:

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

ifMatch - ETag of the pipeline 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:

pipeline resource type along with Response<T>.

createPipelineRun

public CreateRunResponse createPipelineRun(String pipelineName)

Creates a run of a pipeline.

Parameters:

pipelineName - The pipeline name.

Returns:

response body with a run identifier.

createPipelineRun

public CreateRunResponse createPipelineRun(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map parameters)

Creates a run of a pipeline.

Parameters:

pipelineName - The pipeline name.

referencePipelineRunId - The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.

isRecovery - Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

startActivityName - In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

parameters - Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

Returns:

response body with a run identifier.

createPipelineRunWithResponse

public Response createPipelineRunWithResponse(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map parameters, Context context)

Creates a run of a pipeline.

Parameters:

pipelineName - The pipeline name.

referencePipelineRunId - The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.

isRecovery - Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

startActivityName - In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

parameters - Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

context - The context to associate with this operation.

Returns:

response body with a run identifier along with Response<T>.

deletePipeline

public void deletePipeline(String pipelineName)

Deletes a pipeline.

Parameters:

pipelineName - The pipeline name.

deletePipelineWithResponse

public Response deletePipelineWithResponse(String pipelineName, Context context)

Deletes a pipeline.

Parameters:

pipelineName - The pipeline name.

context - The context to associate with this operation.

Returns:

the Response<T>.

getPipeline

public PipelineResource getPipeline(String pipelineName)

Gets a pipeline.

Parameters:

pipelineName - The pipeline name.

Returns:

a pipeline.

getPipeline

public PipelineResource getPipeline(String pipelineName, String ifNoneMatch)

Gets a pipeline.

Parameters:

pipelineName - The pipeline name.

ifNoneMatch - ETag of the pipeline 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 pipeline.

getPipelineWithResponse

public Response getPipelineWithResponse(String pipelineName, String ifNoneMatch, Context context)

Gets a pipeline.

Parameters:

pipelineName - The pipeline name.

ifNoneMatch - ETag of the pipeline 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 pipeline along with Response<T>.

getPipelinesByWorkspace

public PagedIterable getPipelinesByWorkspace()

Lists pipelines.

Returns:

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

getPipelinesByWorkspace

public PagedIterable getPipelinesByWorkspace(Context context)

Lists pipelines.

Parameters:

context - The context to associate with this operation.

Returns:

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

renamePipeline

public void renamePipeline(String pipelineName, ArtifactRenameRequest request)

Renames a pipeline.

Parameters:

pipelineName - The pipeline name.

request - proposed new name.

renamePipelineWithResponse

public Response renamePipelineWithResponse(String pipelineName, ArtifactRenameRequest request, Context context)

Renames a pipeline.

Parameters:

pipelineName - The pipeline name.

request - proposed new name.

context - The context to associate with this operation.

Returns:

the Response<T>.