Package com.azure.resourcemanager.datafactory.models

Interface PipelineResource

  • public interface PipelineResource
    An immutable client-side representation of PipelineResource.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The resource name.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The resource type.
        Returns:
        the type value.

      • etag

        String etag()
        Gets the etag property: Etag identifies change in the resource.
        Returns:
        the etag value.

      • additionalProperties

        Map<String,​Object> additionalProperties()
        Gets the additionalProperties property: Pipeline resource type.
        Returns:
        the additionalProperties value.

      • description

        String description()
        Gets the description property: The description of the pipeline.
        Returns:
        the description value.

      • activities

        List<Activity> activities()
        Gets the activities property: List of activities in pipeline.
        Returns:
        the activities value.

      • parameters

        Map<String,​ParameterSpecification> parameters()
        Gets the parameters property: List of parameters for pipeline.
        Returns:
        the parameters value.

      • variables

        Map<String,​VariableSpecification> variables()
        Gets the variables property: List of variables for pipeline.
        Returns:
        the variables value.

      • concurrency

        Integer concurrency()
        Gets the concurrency property: The max number of concurrent runs for the pipeline.
        Returns:
        the concurrency value.

      • annotations

        List<Object> annotations()
        Gets the annotations property: List of tags that can be used for describing the Pipeline.
        Returns:
        the annotations value.

      • runDimensions

        Map<String,​Object> runDimensions()
        Gets the runDimensions property: Dimensions emitted by Pipeline.
        Returns:
        the runDimensions value.

      • folder

        PipelineFolder folder()
        Gets the folder property: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.
        Returns:
        the folder value.

      • policy

        PipelinePolicy policy()
        Gets the policy property: Pipeline Policy.
        Returns:
        the policy value.

      • innerModel

        PipelineResourceInner innerModel()
        Gets the inner com.azure.resourcemanager.datafactory.fluent.models.PipelineResourceInner object.
        Returns:
        the inner object.

      • update

        PipelineResource.Update update()
        Begins update for the PipelineResource resource.
        Returns:
        the stage of resource update.

      • refresh

        PipelineResource refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        PipelineResource refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • createRun

        CreateRunResponse createRun()
        Creates a run of a pipeline.
        Returns:
        response body with a run identifier.
        Throws:
        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 referencePipelineRunId,
                                                                           Boolean isRecovery,
                                                                           String startActivityName,
                                                                           Boolean startFromFailure,
                                                                           Map<String,​Object> parameters,
                                                                           com.azure.core.util.Context context)
        Creates a run of a pipeline.
        Parameters:
        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.