Package org.odpi.openmetadata.accessservices.governanceengine.rest

Class GovernanceActionRequestBody

  • All Implemented Interfaces:
    Serializable
    public class GovernanceActionRequestBody
extends Object
implements Serializable
    GovernanceActionRequestBody provides a structure for passing the properties for a new governance action.
    See Also:
    Serialized Form

    • Constructor Detail

      • GovernanceActionRequestBody

        public GovernanceActionRequestBody()
        Default constructor

      • GovernanceActionRequestBody

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

    • Method Detail

      • getQualifiedName

        public String getQualifiedName()
        Return the qualified name for this new governance action.
        Returns:
        string name

      • setQualifiedName

        public void setQualifiedName​(String qualifiedName)
        Set up the qualified name of this new governance action.
        Parameters:
        qualifiedName - string name

      • 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

      • getRequestSourceGUIDs

        public List<String> getRequestSourceGUIDs()
        Return the list of elements that triggered this request.
        Returns:
        list of string guids

      • setRequestSourceGUIDs

        public void setRequestSourceGUIDs​(List<String> requestSourceGUIDs)
        Set up the list of elements that triggered this request.
        Parameters:
        requestSourceGUIDs - list of string guids

      • getActionTargets

        public List<NewActionTarget> getActionTargets()
        Return the list of elements that the governance action will work on.
        Returns:
        list of name to string guids

      • setActionTargets

        public void setActionTargets​(List<NewActionTarget> actionTargets)
        Set up the list of elements that the governance action will work on.
        Parameters:
        actionTargets - list of names to string guids

      • getReceivedGuards

        public List<String> getReceivedGuards()
        Return the list of guards that should be passed to the governance service that executes this request.
        Returns:
        list of strings

      • setReceivedGuards

        public void setReceivedGuards​(List<String> receivedGuards)
        Set up the list of guards that should be passed to the governance service that executes this request.
        Parameters:
        receivedGuards - list of strings

      • getStartTime

        public Date getStartTime()
        Return the time that this governance action should start (null means as soon as possible).
        Returns:
        date object

      • setStartTime

        public void setStartTime​(Date startTime)
        Set up the time that this governance action should start (null means as soon as possible).
        Parameters:
        startTime - date object

      • 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

      • getProcessName

        public String getProcessName()
        Return the name of the process that this action belongs to.
        Returns:
        name

      • setProcessName

        public void setProcessName​(String processName)
        Set up the name of the process that this action belongs to.
        Parameters:
        processName - name

      • getRequestSourceName

        public String getRequestSourceName()
        Return the name of the request source.
        Returns:
        string name

      • setRequestSourceName

        public void setRequestSourceName​(String requestSourceName)
        Set up the name of the request source.
        Parameters:
        requestSourceName - string name

      • getOriginatorServiceName

        public String getOriginatorServiceName()
        Set up the unique name of the service that created this request.
        Returns:
        string name

      • setOriginatorServiceName

        public void setOriginatorServiceName​(String originatorServiceName)
        Set up the unique name of the service that created this request.
        Parameters:
        originatorServiceName - string name

      • getOriginatorEngineName

        public String getOriginatorEngineName()
        Return the qualified name of the governance engine that originated this request (if any).
        Returns:
        string name

      • setOriginatorEngineName

        public void setOriginatorEngineName​(String originatorEngineName)
        Set up the qualified name of the governance engine that originated this request (if any).
        Parameters:
        originatorEngineName - string name

      • toString

        public String toString()
        JSON-style toString.
        Overrides:
        toString in class Object
        Returns:
        list of properties and their values.

      • equals

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

      • hashCode

        public int hashCode()
        Return hash code for this object
        Overrides:
        hashCode in class Object
        Returns:
        int hash code