Class PipelineExpressionFunctionProvider

  • All Implemented Interfaces:
    com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider, com.netflix.spinnaker.kork.expressions.ExpressionFunctionProvider, com.netflix.spinnaker.kork.plugins.api.internal.SpinnakerExtensionPoint, org.pf4j.ExtensionPoint

    @Component
    public class PipelineExpressionFunctionProvider
    extends java.lang.Object
    implements com.netflix.spinnaker.kork.expressions.ExpressionFunctionProvider
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider

        com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.FunctionDefinition, com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.FunctionDocumentation, com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.FunctionParameter, com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.Functions, com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.FunctionUsageExample
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @NotNull com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.Functions getFunctions()  
      @Nullable java.lang.String getNamespace()  
      static java.lang.String pipelineId​(com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution execution, java.lang.String pipelineName)
      Function to convert pipeline name to pipeline ID (within current application)
      static java.lang.String pipelineIdInApplication​(com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution execution, java.lang.String pipelineName, java.lang.String applicationName)
      Function to convert pipeline name/application name to pipeline ID
      static java.lang.String pipelineIdOrNull​(com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution execution, java.lang.String pipelineName)
      Function to convert pipeline name to pipeline ID (within current application), will return Null if pipeline ID not found
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.netflix.spinnaker.kork.plugins.api.internal.SpinnakerExtensionPoint

        getExtensionClass, getPluginId
    • Method Detail

      • getNamespace

        @Nullable
        public @Nullable java.lang.String getNamespace()
        Specified by:
        getNamespace in interface com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider
      • getFunctions

        @NotNull
        public @NotNull com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.Functions getFunctions()
        Specified by:
        getFunctions in interface com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider
      • pipelineId

        public static java.lang.String pipelineId​(com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution execution,
                                                  java.lang.String pipelineName)
        Function to convert pipeline name to pipeline ID (within current application)
        Parameters:
        execution - the current execution
        pipelineName - name of the pipeline to lookup
        Returns:
        the id of the pipeline or exception if pipeline not found
      • pipelineIdOrNull

        public static java.lang.String pipelineIdOrNull​(com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution execution,
                                                        java.lang.String pipelineName)
        Function to convert pipeline name to pipeline ID (within current application), will return Null if pipeline ID not found
        Parameters:
        execution - the current execution
        pipelineName - name of the pipeline to lookup
        Returns:
        the id of the pipeline or null if pipeline not found
      • pipelineIdInApplication

        public static java.lang.String pipelineIdInApplication​(com.netflix.spinnaker.orca.api.pipeline.models.PipelineExecution execution,
                                                               java.lang.String pipelineName,
                                                               java.lang.String applicationName)
        Function to convert pipeline name/application name to pipeline ID
        Parameters:
        execution - the current execution
        pipelineName - name of the pipeline to lookup
        applicationName - name of the application
        Returns:
        the id of the pipeline or null if pipeline not found