Class PipelineClient
java.lang.Object
com.azure.analytics.synapse.artifacts.PipelineClient
Initializes a new instance of the synchronous ArtifactsClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdatePipeline
(String pipelineName, PipelineResource pipeline) Creates or updates a pipeline.createOrUpdatePipeline
(String pipelineName, PipelineResource pipeline, String ifMatch) Creates or updates a pipeline.createOrUpdatePipelineWithResponse
(String pipelineName, PipelineResource pipeline, String ifMatch, Context context) Creates or updates a pipeline.createPipelineRun
(String pipelineName) Creates a run of a pipeline.createPipelineRun
(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String, Object> parameters) Creates a run of a pipeline.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.deletePipelineWithResponse
(String pipelineName, Context context) Deletes a pipeline.getPipeline
(String pipelineName) Gets a pipeline.getPipeline
(String pipelineName, String ifNoneMatch) Gets a pipeline.Lists pipelines.getPipelinesByWorkspace
(Context context) Lists pipelines.getPipelineWithResponse
(String pipelineName, String ifNoneMatch, Context context) Gets a pipeline.void
renamePipeline
(String pipelineName, ArtifactRenameRequest request) Renames a pipeline.renamePipelineWithResponse
(String pipelineName, ArtifactRenameRequest request, Context context) Renames a pipeline.
-
Method Details
-
getPipelinesByWorkspace
Lists pipelines.- Returns:
- a list of pipeline 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.
-
getPipelinesByWorkspace
Lists pipelines.- Parameters:
context
- The context to associate with this operation.- Returns:
- a list of pipeline 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.
-
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.
- 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.
-
createOrUpdatePipeline
Creates or updates a pipeline.- Parameters:
pipelineName
- The pipeline name.pipeline
- Pipeline resource definition.- Returns:
- pipeline 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.
-
createOrUpdatePipelineWithResponse
public Response<PipelineResource> 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
. - 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.
-
getPipeline
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.
- 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.
-
getPipeline
Gets a pipeline.- Parameters:
pipelineName
- The pipeline name.- Returns:
- a pipeline.
- 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.
-
getPipelineWithResponse
public Response<PipelineResource> 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
. - 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.
-
deletePipeline
Deletes a pipeline.- Parameters:
pipelineName
- The pipeline 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.
-
deletePipelineWithResponse
Deletes a pipeline.- Parameters:
pipelineName
- The pipeline 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.
-
renamePipeline
Renames a pipeline.- Parameters:
pipelineName
- The pipeline 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.
-
renamePipelineWithResponse
public Response<Void> 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
. - 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.
-
createPipelineRun
public CreateRunResponse createPipelineRun(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String, Object> 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.
- 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.
-
createPipelineRun
Creates a run of a pipeline.- Parameters:
pipelineName
- The pipeline name.- Returns:
- response body with a run identifier.
- 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.
-
createPipelineRunWithResponse
public Response<CreateRunResponse> createPipelineRunWithResponse(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String, Object> 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
. - 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.
-