Package com.azure.resourcemanager.datafactory.models

Interface Pipelines

public interface Pipelines
Resource collection API of Pipelines.

  • Method Details

    • listByFactory

      com.azure.core.http.rest.PagedIterable<PipelineResource> 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<PipelineResource> 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.

    • getWithResponse

      com.azure.core.http.rest.Response<PipelineResource> 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.

    • get

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

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

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

    • createRunWithResponse

      com.azure.core.http.rest.Response<CreateRunResponse> 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.

    • createRun

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

    • getById

      PipelineResource getById(String id)
      Gets a pipeline.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<PipelineResource> getByIdWithResponse(String id, String ifNoneMatch, com.azure.core.util.Context context)
      Gets a pipeline.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes a pipeline.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a pipeline.
      Parameters:
      id - the resource ID.
      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.

    • define

      PipelineResource.DefinitionStages.Blank define(String name)
      Begins definition for a new PipelineResource resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new PipelineResource definition.