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

Class CompletionStatusRequestBody

  • All Implemented Interfaces:
    Serializable
    public class CompletionStatusRequestBody
extends Object
implements Serializable
    CompletionStatusRequestBody provides a structure for passing the properties to record that a governance service finished a governance action.
    See Also:
    Serialized Form

    • Constructor Detail

      • CompletionStatusRequestBody

        public CompletionStatusRequestBody()
        Default constructor

      • CompletionStatusRequestBody

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

    • Method Detail

      • getStatus

        public CompletionStatus getStatus()
        Return the completion status supplied by the governance service when it completed.
        Returns:
        completion status enum

      • setStatus

        public void setStatus​(CompletionStatus status)
        Set up the completion status.
        Parameters:
        status - completion status enum

      • 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

      • getOutputGuards

        public List<String> getOutputGuards()
        Return the list of guards supplied by the governance service when it completed.
        Returns:
        list of string guids

      • setOutputGuards

        public void setOutputGuards​(List<String> outputGuards)
        Set up the list of guards supplied by the governance service when it completed.
        Parameters:
        outputGuards - list of string guids

      • getNewActionTargets

        public List<NewActionTarget> getNewActionTargets()
        Return the metadata elements that the next governance action should target.
        Returns:
        list of names to string guids

      • setNewActionTargets

        public void setNewActionTargets​(List<NewActionTarget> newActionTargets)
        Set up the list of metadata elements that the next governance action should target.
        Parameters:
        newActionTargets - list of names to string guids

      • getCompletionMessage

        public String getCompletionMessage()
        Return message to describe completion results or reasons for failure.
        Returns:
        string

      • setCompletionMessage

        public void setCompletionMessage​(String completionMessage)
        Set up message to describe completion results or reasons for failure.
        Parameters:
        completionMessage - string

      • 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