Package com.azure.resourcemanager.datafactory.fluent

Interface PipelinesClient

public interface PipelinesClient

An instance of this class provides access to all the operations defined in PipelinesClient.

Method Summary

Modifier and Type	Method	Description
PipelineResourceInner	createOrUpdate(String resourceGroupName, String factoryName, String pipelineName, PipelineResourceInner pipeline)	Creates or updates a pipeline.
com.azure.core.http.rest.Response<PipelineResourceInner>	createOrUpdateWithResponse(String resourceGroupName, String factoryName, String pipelineName, PipelineResourceInner pipeline, String ifMatch, com.azure.core.util.Context context)	Creates or updates a pipeline.
CreateRunResponseInner	createRun(String resourceGroupName, String factoryName, String pipelineName)	Creates a run of a pipeline.
com.azure.core.http.rest.Response<CreateRunResponseInner>	createRunWithResponse(String resourceGroupName, String factoryName, String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Boolean startFromFailure, Map<String,Object> parameters, com.azure.core.util.Context context)	Creates a run of a pipeline.
void	delete(String resourceGroupName, String factoryName, String pipelineName)	Deletes a pipeline.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, String pipelineName, com.azure.core.util.Context context)	Deletes a pipeline.
PipelineResourceInner	get(String resourceGroupName, String factoryName, String pipelineName)	Gets a pipeline.
com.azure.core.http.rest.Response<PipelineResourceInner>	getWithResponse(String resourceGroupName, String factoryName, String pipelineName, String ifNoneMatch, com.azure.core.util.Context context)	Gets a pipeline.
com.azure.core.http.rest.PagedIterable<PipelineResourceInner>	listByFactory(String resourceGroupName, String factoryName)	Lists pipelines.
com.azure.core.http.rest.PagedIterable<PipelineResourceInner>	listByFactory(String resourceGroupName, String factoryName, com.azure.core.util.Context context)	Lists pipelines.

Method Detail

listByFactory

com.azure.core.http.rest.PagedIterable<PipelineResourceInner> listByFactory(String resourceGroupName,
                                                                            String factoryName)

Lists pipelines.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

Returns:

a list of pipeline resources as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByFactory

com.azure.core.http.rest.PagedIterable<PipelineResourceInner> listByFactory(String resourceGroupName,
                                                                            String factoryName,
                                                                            com.azure.core.util.Context context)

Lists pipelines.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

PipelineResourceInner createOrUpdate(String resourceGroupName,
                                     String factoryName,
                                     String pipelineName,
                                     PipelineResourceInner pipeline)

Creates or updates a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

Returns:

pipeline resource type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<PipelineResourceInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                    String factoryName,
                                                                                    String pipelineName,
                                                                                    PipelineResourceInner pipeline,
                                                                                    String ifMatch,
                                                                                    com.azure.core.util.Context context)

Creates or updates a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

PipelineResourceInner get(String resourceGroupName,
                          String factoryName,
                          String pipelineName)

Gets a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

pipelineName - The pipeline name.

Returns:

a pipeline.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<PipelineResourceInner> getWithResponse(String resourceGroupName,
                                                                         String factoryName,
                                                                         String pipelineName,
                                                                         String ifNoneMatch,
                                                                         com.azure.core.util.Context context)

Gets a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String factoryName,
            String pipelineName)

Deletes a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

pipelineName - The pipeline name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String factoryName,
                                                           String pipelineName,
                                                           com.azure.core.util.Context context)

Deletes a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

pipelineName - The pipeline name.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createRun

CreateRunResponseInner createRun(String resourceGroupName,
                                 String factoryName,
                                 String pipelineName)

Creates a run of a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

pipelineName - The pipeline name.

Returns:

response body with a run identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createRunWithResponse

com.azure.core.http.rest.Response<CreateRunResponseInner> createRunWithResponse(String resourceGroupName,
                                                                                String factoryName,
                                                                                String pipelineName,
                                                                                String referencePipelineRunId,
                                                                                Boolean isRecovery,
                                                                                String startActivityName,
                                                                                Boolean startFromFailure,
                                                                                Map<String,Object> parameters,
                                                                                com.azure.core.util.Context context)

Creates a run of a pipeline.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

startFromFailure - In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified.

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.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.