Validate Pipeline Definition

datapipeline_validate_pipeline_definition

R Documentation

Validates the specified pipeline definition to ensure that it is well formed and can be run without error¶

Description¶

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Usage¶

datapipeline_validate_pipeline_definition(pipelineId, pipelineObjects,
  parameterObjects, parameterValues)

Arguments¶

pipelineId: [required] The ID of the pipeline.
pipelineObjects: [required] The objects that define the pipeline changes to validate against the pipeline.
parameterObjects: The parameter objects used with the pipeline.
parameterValues: The parameter values used with the pipeline.

Value¶

A list with the following syntax:

list(
  validationErrors = list(
    list(
      id = "string",
      errors = list(
        "string"
      )
    )
  ),
  validationWarnings = list(
    list(
      id = "string",
      warnings = list(
        "string"
      )
    )
  ),
  errored = TRUE|FALSE
)

Request syntax¶

svc$validate_pipeline_definition(
  pipelineId = "string",
  pipelineObjects = list(
    list(
      id = "string",
      name = "string",
      fields = list(
        list(
          key = "string",
          stringValue = "string",
          refValue = "string"
        )
      )
    )
  ),
  parameterObjects = list(
    list(
      id = "string",
      attributes = list(
        list(
          key = "string",
          stringValue = "string"
        )
      )
    )
  ),
  parameterValues = list(
    list(
      id = "string",
      stringValue = "string"
    )
  )
)