java.lang.Object
- us.kbase.workspace.ProvenanceAction

@Generated("com.googlecode.jsonschema2pojo")
public class ProvenanceAction
extends Object

Original spec-file type: ProvenanceAction

A provenance action.
A provenance action (PA) is an action taken while transforming one data
object to another. There may be several PAs taken in series. A PA is
typically running a script, running an api command, etc. All of the
following fields are optional, but more information provided equates to
better data provenance.
If a provenance action has no fields defined at all, it is silently dropped from
the list.
resolved_ws_objects should never be set by the user; it is set by the
workspace service when returning data.
On input, only one of the time or epoch may be supplied. Both are
supplied on output.
The maximum size of the entire provenance object, including all actions,
is 1MB.
timestamp time - the time the action was started
epoch epoch - the time the action was started.
string caller - the name or id of the invoker of this provenance
action. In most cases, this will be the same for all PAs.
string service - the name of the service that performed this action.
string service_ver - the version of the service that performed this action.
string method - the method of the service that performed this action.
list method_params - the parameters of the method
that performed this action. If an object in the parameters is a
workspace object, also put the object reference in the
input_ws_object list.
string script - the name of the script that performed this action.
string script_ver - the version of the script that performed this action.
string script_command_line - the command line provided to the script
that performed this action. If workspace objects were provided in
the command line, also put the object reference in the
input_ws_object list.
list input_ws_objects - the workspace objects that
were used as input to this action; typically these will also be
present as parts of the method_params or the script_command_line
arguments. A reference path into the object graph may be supplied.
list resolved_ws_objects - the workspace objects ids from
input_ws_objects resolved to permanent workspace object references
by the workspace service.
list intermediate_incoming - if the previous action produced
output that 1) was not stored in a referrable way, and 2) is
used as input for this action, provide it with an arbitrary and
unique ID here, in the order of the input arguments to this action.
These IDs can be used in the method_params argument.
list intermediate_outgoing - if this action produced output
that 1) was not stored in a referrable way, and 2) is
used as input for the next action, provide it with an arbitrary and
unique ID here, in the order of the output values from this action.
These IDs can be used in the intermediate_incoming argument in the
next action.
list external_data - data external to the workspace
that was either imported to the workspace or used to create a
workspace object.
list subactions - the subactions taken as a part of this
action.
mapping custom - user definable custom provenance
fields and their values.
string description - a free text description of this action.

Constructor Summary

Constructors
Constructor Description

ProvenanceAction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getCaller()`
`Map<String,String>`	`getCustom()`
`String`	`getDescription()`
`Long`	`getEpoch()`
`List<ExternalDataUnit>`	`getExternalData()`
`List<String>`	`getInputWsObjects()`
`List<String>`	`getIntermediateIncoming()`
`List<String>`	`getIntermediateOutgoing()`
`String`	`getMethod()`
`List<UObject>`	`getMethodParams()`
`List<String>`	`getResolvedWsObjects()`
`String`	`getScript()`
`String`	`getScriptCommandLine()`
`String`	`getScriptVer()`
`String`	`getService()`
`String`	`getServiceVer()`
`List<SubAction>`	`getSubactions()`
`String`	`getTime()`
`void`	`setAdditionalProperties(String name, Object value)`
`void`	`setCaller(String caller)`
`void`	`setCustom(Map<String,String> custom)`
`void`	`setDescription(String description)`
`void`	`setEpoch(Long epoch)`
`void`	`setExternalData(List<ExternalDataUnit> externalData)`
`void`	`setInputWsObjects(List<String> inputWsObjects)`
`void`	`setIntermediateIncoming(List<String> intermediateIncoming)`
`void`	`setIntermediateOutgoing(List<String> intermediateOutgoing)`
`void`	`setMethod(String method)`
`void`	`setMethodParams(List<UObject> methodParams)`
`void`	`setResolvedWsObjects(List<String> resolvedWsObjects)`
`void`	`setScript(String script)`
`void`	`setScriptCommandLine(String scriptCommandLine)`
`void`	`setScriptVer(String scriptVer)`
`void`	`setService(String service)`
`void`	`setServiceVer(String serviceVer)`
`void`	`setSubactions(List<SubAction> subactions)`
`void`	`setTime(String time)`
`String`	`toString()`
`ProvenanceAction`	`withCaller(String caller)`
`ProvenanceAction`	`withCustom(Map<String,String> custom)`
`ProvenanceAction`	`withDescription(String description)`
`ProvenanceAction`	`withEpoch(Long epoch)`
`ProvenanceAction`	`withExternalData(List<ExternalDataUnit> externalData)`
`ProvenanceAction`	`withInputWsObjects(List<String> inputWsObjects)`
`ProvenanceAction`	`withIntermediateIncoming(List<String> intermediateIncoming)`
`ProvenanceAction`	`withIntermediateOutgoing(List<String> intermediateOutgoing)`
`ProvenanceAction`	`withMethod(String method)`
`ProvenanceAction`	`withMethodParams(List<UObject> methodParams)`
`ProvenanceAction`	`withResolvedWsObjects(List<String> resolvedWsObjects)`
`ProvenanceAction`	`withScript(String script)`
`ProvenanceAction`	`withScriptCommandLine(String scriptCommandLine)`
`ProvenanceAction`	`withScriptVer(String scriptVer)`
`ProvenanceAction`	`withService(String service)`
`ProvenanceAction`	`withServiceVer(String serviceVer)`
`ProvenanceAction`	`withSubactions(List<SubAction> subactions)`
`ProvenanceAction`	`withTime(String time)`

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

Constructor Detail
- ProvenanceAction
```
public ProvenanceAction()
```

Method Detail

getTime
```
public String getTime()
```

setTime
```
public void setTime(String time)
```

withTime

public ProvenanceAction withTime(String time)

getEpoch
```
public Long getEpoch()
```

setEpoch
```
public void setEpoch(Long epoch)
```

withEpoch

public ProvenanceAction withEpoch(Long epoch)

getCaller
```
public String getCaller()
```

setCaller

public void setCaller(String caller)

withCaller

public ProvenanceAction withCaller(String caller)

getService
```
public String getService()
```

setService

public void setService(String service)

withService

public ProvenanceAction withService(String service)

getServiceVer
```
public String getServiceVer()
```

setServiceVer

public void setServiceVer(String serviceVer)

withServiceVer

public ProvenanceAction withServiceVer(String serviceVer)

getMethod
```
public String getMethod()
```

setMethod

public void setMethod(String method)

withMethod

public ProvenanceAction withMethod(String method)

getMethodParams

public List<UObject> getMethodParams()

setMethodParams

public void setMethodParams(List<UObject> methodParams)

withMethodParams

public ProvenanceAction withMethodParams(List<UObject> methodParams)

getScript
```
public String getScript()
```

setScript

public void setScript(String script)

withScript

public ProvenanceAction withScript(String script)

getScriptVer
```
public String getScriptVer()
```

setScriptVer

public void setScriptVer(String scriptVer)

withScriptVer

public ProvenanceAction withScriptVer(String scriptVer)

getScriptCommandLine
```
public String getScriptCommandLine()
```

setScriptCommandLine

public void setScriptCommandLine(String scriptCommandLine)

withScriptCommandLine

public ProvenanceAction withScriptCommandLine(String scriptCommandLine)

getInputWsObjects

public List<String> getInputWsObjects()

setInputWsObjects

public void setInputWsObjects(List<String> inputWsObjects)

withInputWsObjects

public ProvenanceAction withInputWsObjects(List<String> inputWsObjects)

getResolvedWsObjects

public List<String> getResolvedWsObjects()

setResolvedWsObjects

public void setResolvedWsObjects(List<String> resolvedWsObjects)

withResolvedWsObjects

public ProvenanceAction withResolvedWsObjects(List<String> resolvedWsObjects)

getIntermediateIncoming

public List<String> getIntermediateIncoming()

setIntermediateIncoming

public void setIntermediateIncoming(List<String> intermediateIncoming)

withIntermediateIncoming

public ProvenanceAction withIntermediateIncoming(List<String> intermediateIncoming)

getIntermediateOutgoing

public List<String> getIntermediateOutgoing()

setIntermediateOutgoing

public void setIntermediateOutgoing(List<String> intermediateOutgoing)

withIntermediateOutgoing

public ProvenanceAction withIntermediateOutgoing(List<String> intermediateOutgoing)

getExternalData

public List<ExternalDataUnit> getExternalData()

setExternalData

public void setExternalData(List<ExternalDataUnit> externalData)

withExternalData

public ProvenanceAction withExternalData(List<ExternalDataUnit> externalData)

getSubactions

public List<SubAction> getSubactions()

setSubactions

public void setSubactions(List<SubAction> subactions)

withSubactions

public ProvenanceAction withSubactions(List<SubAction> subactions)

getCustom

public Map<String,String> getCustom()

setCustom

public void setCustom(Map<String,String> custom)

withCustom

public ProvenanceAction withCustom(Map<String,String> custom)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

withDescription

public ProvenanceAction withDescription(String description)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(String name,
                                    Object value)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ProvenanceAction

Constructor Summary