Package flexagon.fd.services.groovy.functions

Class TopologyFunctions

java.lang.Object
flexagon.fd.services.groovy.functions.BaseFunctions
flexagon.fd.services.groovy.functions.TopologyFunctions
Direct Known Subclasses:
EnvironmentTopologyFunctions
public class TopologyFunctions extends BaseFunctions

  • Constructor Details

    • TopologyFunctions

      public TopologyFunctions()

    • TopologyFunctions

      public TopologyFunctions(LogFunctions pLogFunctions)

  • Method Details

    • getInstanceProperties

      @Deprecated(since="9.0.0.7", forRemoval=true) public Map<String,Serializable> getInstanceProperties(String pTargetGroupCode)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTargetGroupProperties

      public Map<String,Serializable> getTargetGroupProperties(String pTargetGroupCode)
      returns a Map<String, Object> containing all the properties for the integration account matching the passed target group code.
      Key of map is a property code and value is the primitive value for that property.
      e.g. Git SCM Account [FDGIT_URL: https://github.com/flexagon9/flextest.git, FDGIT_USER: flexagon9, FDGIT_PASSWORD: password123, FDGIT_TIMEOUT: null]
      Parameters:
      pTargetGroupCode - InstanceCode of the instance properties you want
      Returns:
      Map of instance properties. Key is code, Value is property value.

    • getTargetGroupById

      public TargetGroup getTargetGroupById(Long pTargetGroupId)
      Get the TargetGroup based on TargetGroup id passed.
      Parameters:
      pTargetGroupId - the target group id
      Returns:
      TargetGroupDataObject
      Throws:
      FlexRowNotFoundException - If TargetGroup not found for given pTargetGroupId

    • getTargetGroupByCode

      public TargetGroup getTargetGroupByCode(String pTargetGroupCode)
      Get the TargetGroup based on TargetGroup code passed.
      Parameters:
      pTargetGroupCode - the target group code
      Returns:
      TargetGroupDataObject
      Throws:
      FlexRowNotFoundException - If TargetGroup not found for given pTargetGroupCode

    • getEnvironmentById

      public EnvironmentDetails getEnvironmentById(Long pEnvironmentId)
      Returns Environment information for a given environment Id.
      Parameters:
      pEnvironmentId - Environment id of the Environment to retrieve
      Returns:
      Object containing metadata about the given Environment
      Throws:
      FlexRowNotFoundException - If Environment not found for given pEnvironmentId

    • getEnvironmentByCode

      public EnvironmentDetails getEnvironmentByCode(String pEnvironmentCode)
      Returns Environment information for a given environment code.
      Parameters:
      pEnvironmentCode - Environment code of the Environment to retrieve
      Returns:
      Object containing metadata about the given Environment
      Throws:
      FlexRowNotFoundException - If Environment not found for given pEnvironmentCode

    • getGroovyKey

      public String getGroovyKey()
      Gets the groovy key.
      Specified by:
      getGroovyKey in class BaseFunctions
      Returns:
      the groovy key

    • cleanup

      public void cleanup()
      Cleanup.
      Specified by:
      cleanup in class BaseFunctions