Package org.odpi.openmetadata.frameworkservices.gaf.rest

Class CompletionStatusRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.rest.CompletionStatusRequestBody
public class CompletionStatusRequestBody extends Object
CompletionStatusRequestBody provides a structure for passing the properties to record that a governance service finished a governance action.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompletionStatusRequestBody()
    Default constructor
    CompletionStatusRequestBody(CompletionStatusRequestBody template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    String
    getCompletionMessage()
    Return message to describe completion results or reasons for failure.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget>
    getNewActionTargets()
    Return the metadata elements that the next governance action should target.
    List<String>
    getOutputGuards()
    Return the list of guards supplied by the governance service when it completed.
    Map<String,String>
    getRequestParameters()
    Return the parameters to pass onto the governance service.
    org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus
    getStatus()
    Return the completion status supplied by the governance service when it completed.
    int
    hashCode()
    Return hash code for this object
    void
    setCompletionMessage(String completionMessage)
    Set up message to describe completion results or reasons for failure.
    void
    setNewActionTargets(List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> newActionTargets)
    Set up the list of metadata elements that the next governance action should target.
    void
    setOutputGuards(List<String> outputGuards)
    Set up the list of guards supplied by the governance service when it completed.
    void
    setRequestParameters(Map<String,String> requestParameters)
    Set up the parameters to pass onto the governance service.
    void
    setStatus(org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus status)
    Set up the completion status.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CompletionStatusRequestBody

      public CompletionStatusRequestBody()
      Default constructor

    • CompletionStatusRequestBody

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

  • Method Details

    • getStatus

      public org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus getStatus()
      Return the completion status supplied by the governance service when it completed.
      Returns:
      completion status enum

    • setStatus

      public void setStatus(org.odpi.openmetadata.frameworks.governanceaction.properties.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<org.odpi.openmetadata.frameworks.governanceaction.properties.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<org.odpi.openmetadata.frameworks.governanceaction.properties.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