Package com.azure.analytics.synapse.artifacts

Class PipelineAsyncClient

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

  • Method Details

    • getPipelinesByWorkspace

      public com.azure.core.http.rest.PagedFlux<PipelineResource> getPipelinesByWorkspace()
      Lists pipelines.
      Returns:
      a list of pipeline resources as paginated response with PagedFlux.
      Throws:
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdatePipelineWithResponse

      public Mono<com.azure.core.http.rest.Response<PipelineResource>> createOrUpdatePipelineWithResponse(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 along with Response on successful completion of Mono.
      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 Mono<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 on successful completion of Mono.
      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 Mono<PipelineResource> createOrUpdatePipeline(String pipelineName, PipelineResource pipeline)
      Creates or updates a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      pipeline - Pipeline resource definition.
      Returns:
      pipeline resource type on successful completion of Mono.
      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 Mono<com.azure.core.http.rest.Response<PipelineResource>> getPipelineWithResponse(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 along with Response on successful completion of Mono.
      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

      public Mono<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 on successful completion of Mono.
      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

      public Mono<PipelineResource> getPipeline(String pipelineName)
      Gets a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      Returns:
      a pipeline on successful completion of Mono.
      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

      public Mono<com.azure.core.http.rest.Response<Void>> deletePipelineWithResponse(String pipelineName)
      Deletes a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      Returns:
      the Response on successful completion of Mono.
      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

      public Mono<Void> deletePipeline(String pipelineName)
      Deletes a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      Returns:
      A Mono that completes when a successful response is received.
      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 Mono<com.azure.core.http.rest.Response<Void>> renamePipelineWithResponse(String pipelineName, ArtifactRenameRequest request)
      Renames a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      request - proposed new name.
      Returns:
      the Response on successful completion of Mono.
      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

      public Mono<Void> renamePipeline(String pipelineName, ArtifactRenameRequest request)
      Renames a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      request - proposed new name.
      Returns:
      A Mono that completes when a successful response is received.
      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 Mono<com.azure.core.http.rest.Response<CreateRunResponse>> createPipelineRunWithResponse(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 along with Response on successful completion of Mono.
      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 Mono<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 on successful completion of Mono.
      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 Mono<CreateRunResponse> createPipelineRun(String pipelineName)
      Creates a run of a pipeline.
      Parameters:
      pipelineName - The pipeline name.
      Returns:
      response body with a run identifier on successful completion of Mono.
      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.