Skip to main content

pipeline_utils.go

pipeline_utils.go - Overview​

  1. Overview This file provides utility functions for working with integration pipelines, including generating aliases and extracting integration IDs from pipeline aliases.

  2. Detailed Documentation

IntegrationPipelineIdSeparator​

  • Purpose: Defines the separator string used in the alias for integration pipelines.
  • Type: const string
  • Value: "--"

AliasForIntegrationPipeline​

  • Purpose: Generates an alias for an integration pipeline based on the integration ID and pipeline name.
  • Parameters:
    • integrationId (string): The ID of the integration.
    • pipelineName (string): The name of the pipeline.
  • Returns: string: The generated alias for the integration pipeline.

IntegrationIdForPipeline​

  • Purpose: Extracts the integration ID from a pipeline's alias if the pipeline is associated with an installed integration.
  • Parameters:
    • p (pipelinetypes.GettablePipeline): The pipeline object.
  • Returns: *string: A pointer to the integration ID string if p is a pipeline for an installed integration; otherwise, returns nil.
  1. Code Examples

None

  1. Clarity and Accuracy

Documentation is based on code analysis.

  1. Markdown & MDX Perfection

Markdown is properly formatted.

  1. Edge Cases To Avoid Breaking MDX

MDX-incompatible elements are avoided.

  1. Getting Started Relevance Include in Getting Started: NO