GovernanceActionProcessRequestBody (Governance Engine OMAS API 2.11 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceActionProcessRequestBody

All Implemented Interfaces:

Serializable
```
public class GovernanceActionProcessRequestBody
extends Object
implements Serializable
```
GovernanceActionProcessRequestBody provides a structure for passing the properties for initiating a new instance of a governance action process.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`GovernanceActionProcessRequestBody()` Default constructor
`GovernanceActionProcessRequestBody(GovernanceActionProcessRequestBody template)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Equals method that returns true if containing properties are the same.
`List<NewActionTarget>`	`getActionTargets()` Return the list of elements that the governance action process will work on.
`String`	`getOriginatorEngineName()` Return the qualified name of the governance engine that originated this request (if any).
`String`	`getOriginatorServiceName()` Return the unique name of the service that created this request.
`String`	`getProcessQualifiedName()` Return the qualified name of the GovernanceActionProcess that will act as a template for the governance actions that will be created and run.
`Map<String,String>`	`getRequestParameters()` Return the parameters to pass onto the governance service.
`List<String>`	`getRequestSourceGUIDs()` Return the list of elements that triggered this request.
`Date`	`getStartTime()` Return the time that this process should start (null means as soon as possible).
`int`	`hashCode()` Return hash code for this object
`void`	`setActionTargets(List<NewActionTarget> actionTargets)` Set up the list of elements that the governance action process will work on.
`void`	`setOriginatorEngineName(String originatorEngineName)` Set up the qualified name of the governance engine that originated this request (if any).
`void`	`setOriginatorServiceName(String originatorServiceName)` Set up the unique name of the service that created this request.
`void`	`setProcessQualifiedName(String processQualifiedName)` Set up the qualified name of the GovernanceActionProcess that will act as a template for the governance actions that will be created and run.
`void`	`setRequestParameters(Map<String,String> requestParameters)` Set up the parameters to pass onto the governance service.
`void`	`setRequestSourceGUIDs(List<String> requestSourceGUIDs)` Set up the list of elements that triggered this request.
`void`	`setStartTime(Date startTime)` Set up the time that this process should start (null means as soon as possible).
`String`	`toString()` JSON-style toString.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GovernanceActionProcessRequestBody
```
public GovernanceActionProcessRequestBody()
```
    Default constructor
  - GovernanceActionProcessRequestBody
```
public GovernanceActionProcessRequestBody(GovernanceActionProcessRequestBody template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getProcessQualifiedName
```
public String getProcessQualifiedName()
```
    Return the qualified name of the GovernanceActionProcess that will act as a template for the governance actions that will be created and run.
    
    Returns:
    
    string name
  - setProcessQualifiedName
```
public void setProcessQualifiedName(String processQualifiedName)
```
    Set up the qualified name of the GovernanceActionProcess that will act as a template for the governance actions that will be created and run.
    
    Parameters:
    
    processQualifiedName - 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
  - 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 process will work on.
    
    Returns:
    
    map of names to string guids
  - setActionTargets
```
public void setActionTargets(List<NewActionTarget> actionTargets)
```
    Set up the list of elements that the governance action process will work on.
    
    Parameters:
    
    actionTargets - map of names to string guids
  - getStartTime
```
public Date getStartTime()
```
    Return the time that this process should start (null means as soon as possible).
    
    Returns:
    
    date object
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Set up the time that this process should start (null means as soon as possible).
    
    Parameters:
    
    startTime - date object
  - getOriginatorServiceName
```
public String getOriginatorServiceName()
```
    Return 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

Class GovernanceActionProcessRequestBody

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GovernanceActionProcessRequestBody

GovernanceActionProcessRequestBody

Method Detail

getProcessQualifiedName

setProcessQualifiedName

getRequestParameters

setRequestParameters

getRequestSourceGUIDs

setRequestSourceGUIDs

getActionTargets

setActionTargets

getStartTime

setStartTime

getOriginatorServiceName

setOriginatorServiceName

getOriginatorEngineName

setOriginatorEngineName

toString

equals

hashCode