Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class GovernanceActionTypeProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties
Direct Known Subclasses:
GovernanceActionProcessStepProperties
public class GovernanceActionTypeProperties extends ReferenceableProperties
GovernanceActionTypeProperties provides a structure for carrying the properties for a governance action type.

  • Constructor Details

    • GovernanceActionTypeProperties

      public GovernanceActionTypeProperties()
      Default constructor

    • GovernanceActionTypeProperties

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

  • Method Details

    • 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

    • getSupportedRequestParameters

      public List<RequestParameterType> getSupportedRequestParameters()
      Return the required request parameters to supply when using this governance acton type to initiate an action.
      Returns:
      list

    • setSupportedRequestParameters

      public void setSupportedRequestParameters(List<RequestParameterType> supportedRequestParameters)
      Set up the required request parameters to supply when using this governance acton type to initiate an action.
      Parameters:
      supportedRequestParameters - list

    • getSupportedActionTargetTypes

      public List<ActionTargetType> getSupportedActionTargetTypes()
      Return the required action targets to supply when using this governance acton type to initiate an action.
      Returns:
      list

    • setSupportedActionTargetTypes

      public void setSupportedActionTargetTypes(List<ActionTargetType> supportedActionTargetTypes)
      Set up the required action targets to supply when using this governance acton type to initiate an action.
      Parameters:
      supportedActionTargetTypes - list

    • getProducedRequestParameters

      public List<RequestParameterType> getProducedRequestParameters()
      Return the request parameters that are produced by the governance service.
      Returns:
      list

    • setProducedRequestParameters

      public void setProducedRequestParameters(List<RequestParameterType> producedRequestParameters)
      Set up the request parameters that are produced by the governance service.
      Parameters:
      producedRequestParameters - list

    • getProducedActionTargetTypes

      public List<ActionTargetType> getProducedActionTargetTypes()
      Return the action targets that are produced by the governance service.
      Returns:
      list

    • setProducedActionTargetTypes

      public void setProducedActionTargetTypes(List<ActionTargetType> producedActionTargetTypes)
      Set up the action targets that are produced by the governance service.
      Parameters:
      producedActionTargetTypes - list

    • getProducedGuards

      public List<GuardType> getProducedGuards()
      Return the list of guards produced by the governance service.
      Returns:
      list of guards

    • setProducedGuards

      public void setProducedGuards(List<GuardType> producedGuards)
      Set up the list of guards produced by the governance service.
      Parameters:
      producedGuards - 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

    • getFixedRequestParameters

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

    • setFixedRequestParameters

      public void setFixedRequestParameters(Map<String,String> fixedRequestParameters)
      Set up the parameters to pass onto the governance service.
      Parameters:
      fixedRequestParameters - list of properties

    • 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)

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class ReferenceableProperties
      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 ReferenceableProperties
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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