Package org.odpi.openmetadata.accessservices.governanceengine.properties

Class GovernanceActionTypeProperties

  • All Implemented Interfaces:
    Serializable
    public class GovernanceActionTypeProperties
extends ReferenceableProperties
    GovernanceActionTypeProperties provides a structure for carrying the properties for a governance action type.
    See Also:
    Serialized Form

    • Constructor Detail

      • GovernanceActionTypeProperties

        public GovernanceActionTypeProperties()
        Default constructor

      • GovernanceActionTypeProperties

        public GovernanceActionTypeProperties​(GovernanceActionTypeProperties template)
        Copy/clone constructor
        Parameters:
        template - object to copy

    • Method Detail

      • getDomainIdentifier

        public int getDomainIdentifier()
        Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
        Returns:
        int

      • setDomainIdentifier

        public void setDomainIdentifier​(int domainIdentifier)
        Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
        Parameters:
        domainIdentifier - int

      • getDisplayName

        public String getDisplayName()
        Return the display name for the governance action.
        Returns:
        string name

      • setDisplayName

        public void setDisplayName​(String displayName)
        Set up the display name for the governance action.
        Parameters:
        displayName - string name

      • getDescription

        public String getDescription()
        Return the description of the governance action.
        Returns:
        string text

      • setDescription

        public void setDescription​(String description)
        Set up the description of the governance action.
        Parameters:
        description - string text

      • getSupportedGuards

        public List<String> getSupportedGuards()
        Return the list of guards provided by the previous governance service.
        Returns:
        list of guards

      • setSupportedGuards

        public void setSupportedGuards​(List<String> supportedGuards)
        Set up the list of guards provided by the previous governance service.
        Parameters:
        supportedGuards - list of guards

      • getGovernanceEngineGUID

        public String getGovernanceEngineGUID()
        Return the unique identifier of governance engine that is processing the governance action.
        Returns:
        string guid

      • setGovernanceEngineGUID

        public void setGovernanceEngineGUID​(String governanceEngineGUID)
        Set up the unique identifier of governance engine that is processing the governance action.
        Parameters:
        governanceEngineGUID - string guid

      • getRequestType

        public String getRequestType()
        Return the request type associated with this governance action.
        Returns:
        string name

      • setRequestType

        public void setRequestType​(String requestType)
        Set up the request type associated with this governance action, used to identify ths governance service to run.
        Parameters:
        requestType - string name

      • getRequestParameters

        public Map<String,​String> getRequestParameters()
        Return the parameters to pass onto the governance service.
        Returns:
        map of properties

      • setRequestParameters

        public void setRequestParameters​(Map<String,​String> requestParameters)
        Set up the parameters to pass onto the governance service.
        Parameters:
        requestParameters - map of properties

      • getIgnoreMultipleTriggers

        public boolean getIgnoreMultipleTriggers()
        Return whether this action type can be triggered more than once in a single step of the governance action process.
        Returns:
        boolean flag

      • setIgnoreMultipleTriggers

        public void setIgnoreMultipleTriggers​(boolean ignoreMultipleTriggers)
        Set up whether this action type can be triggered more than once in a single step of the governance action process.
        Parameters:
        ignoreMultipleTriggers - boolean flag

      • getWaitTime

        public int getWaitTime()
        Return the minimum number of minutes to wait before starting the next governance action.
        Returns:
        int (minutes)

      • setWaitTime

        public void setWaitTime​(int waitTime)
        Set up the minimum number of minutes to wait before starting the next governance action.
        Parameters:
        waitTime - int (minutes)

      • equals

        public boolean equals​(Object objectToCompare)
        Equals method that returns true if containing properties are the same.
        Overrides:
        equals in class ReferenceableProperties
        Parameters:
        objectToCompare - object to compare
        Returns:
        boolean result of comparison