Package org.odpi.openmetadata.archiveutilities.openconnectors

Enum Class RequestTypeDefinition

java.lang.Object
java.lang.Enum<RequestTypeDefinition>
org.odpi.openmetadata.archiveutilities.openconnectors.RequestTypeDefinition
All Implemented Interfaces:
Serializable, Comparable<RequestTypeDefinition>, Constable
public enum RequestTypeDefinition extends Enum<RequestTypeDefinition>
Defines the request types for the governance engines that identify which governance service to call for a specific request type.

  • Enum Constant Details

  • Method Details

    • values

      public static RequestTypeDefinition[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RequestTypeDefinition valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getGovernanceRequestType

      public String getGovernanceRequestType()
      Return the Request Type.
      Returns:
      string

    • getServiceRequestType

      public String getServiceRequestType()
      Return the service request type to map to.
      Returns:
      string

    • getRequestParameters

      public Map<String,String> getRequestParameters()
      Return the request parameters (if needed).
      Returns:
      map or null

    • getActionTargets

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> getActionTargets()
      Return predefined action targets used by this service. They are attached to the governance action type.
      Returns:
      list

    • getGovernanceEngine

      public GovernanceEngineDefinition getGovernanceEngine()
      Return the governance engine where this request type belongs to.
      Returns:
      governance engine definition enum

    • getGovernanceService

      public GovernanceServiceDefinition getGovernanceService()
      Return the governance service that this request type maps to,
      Returns:
      governance service definition enum

    • getGovernanceActionTypeGUID

      public String getGovernanceActionTypeGUID()
      Return the unique identifier of the governance action type.
      Returns:
      string

    • getSupportedElementQualifiedName

      public String getSupportedElementQualifiedName()
      Return the element that is supported by this request.
      Returns:
      qualified name string

    • getContentPackDefinition

      public ContentPackDefinition getContentPackDefinition()
      Get identifier of content pack where this template should be located.
      Returns:
      content pack definition

    • toString

      public String toString()
      Output of this enum class and main value.
      Overrides:
      toString in class Enum<RequestTypeDefinition>
      Returns:
      string showing enum value