Package us.kbase.workspace

Class ProvenanceAction

  • @Generated("com.googlecode.jsonschema2pojo")
public class ProvenanceAction
extends java.lang.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 Detail

      • ProvenanceAction

        public ProvenanceAction()

    • Method Detail

      • getTime

        public java.lang.String getTime()

      • setTime

        public void setTime​(java.lang.String time)

      • getEpoch

        public java.lang.Long getEpoch()

      • setEpoch

        public void setEpoch​(java.lang.Long epoch)

      • getCaller

        public java.lang.String getCaller()

      • setCaller

        public void setCaller​(java.lang.String caller)

      • getService

        public java.lang.String getService()

      • setService

        public void setService​(java.lang.String service)

      • withService

        public ProvenanceAction withService​(java.lang.String service)

      • getServiceVer

        public java.lang.String getServiceVer()

      • setServiceVer

        public void setServiceVer​(java.lang.String serviceVer)

      • withServiceVer

        public ProvenanceAction withServiceVer​(java.lang.String serviceVer)

      • getMethod

        public java.lang.String getMethod()

      • setMethod

        public void setMethod​(java.lang.String method)

      • getMethodParams

        public java.util.List<UObject> getMethodParams()

      • setMethodParams

        public void setMethodParams​(java.util.List<UObject> methodParams)

      • getScript

        public java.lang.String getScript()

      • setScript

        public void setScript​(java.lang.String script)

      • getScriptVer

        public java.lang.String getScriptVer()

      • setScriptVer

        public void setScriptVer​(java.lang.String scriptVer)

      • withScriptVer

        public ProvenanceAction withScriptVer​(java.lang.String scriptVer)

      • getScriptCommandLine

        public java.lang.String getScriptCommandLine()

      • setScriptCommandLine

        public void setScriptCommandLine​(java.lang.String scriptCommandLine)

      • withScriptCommandLine

        public ProvenanceAction withScriptCommandLine​(java.lang.String scriptCommandLine)

      • getInputWsObjects

        public java.util.List<java.lang.String> getInputWsObjects()

      • setInputWsObjects

        public void setInputWsObjects​(java.util.List<java.lang.String> inputWsObjects)

      • withInputWsObjects

        public ProvenanceAction withInputWsObjects​(java.util.List<java.lang.String> inputWsObjects)

      • getResolvedWsObjects

        public java.util.List<java.lang.String> getResolvedWsObjects()

      • setResolvedWsObjects

        public void setResolvedWsObjects​(java.util.List<java.lang.String> resolvedWsObjects)

      • withResolvedWsObjects

        public ProvenanceAction withResolvedWsObjects​(java.util.List<java.lang.String> resolvedWsObjects)

      • getIntermediateIncoming

        public java.util.List<java.lang.String> getIntermediateIncoming()

      • setIntermediateIncoming

        public void setIntermediateIncoming​(java.util.List<java.lang.String> intermediateIncoming)

      • withIntermediateIncoming

        public ProvenanceAction withIntermediateIncoming​(java.util.List<java.lang.String> intermediateIncoming)

      • getIntermediateOutgoing

        public java.util.List<java.lang.String> getIntermediateOutgoing()

      • setIntermediateOutgoing

        public void setIntermediateOutgoing​(java.util.List<java.lang.String> intermediateOutgoing)

      • withIntermediateOutgoing

        public ProvenanceAction withIntermediateOutgoing​(java.util.List<java.lang.String> intermediateOutgoing)

      • setExternalData

        public void setExternalData​(java.util.List<ExternalDataUnit> externalData)

      • getSubactions

        public java.util.List<SubAction> getSubactions()

      • setSubactions

        public void setSubactions​(java.util.List<SubAction> subactions)

      • getCustom

        public java.util.Map<java.lang.String,​java.lang.String> getCustom()

      • setCustom

        public void setCustom​(java.util.Map<java.lang.String,​java.lang.String> custom)

      • withCustom

        public ProvenanceAction withCustom​(java.util.Map<java.lang.String,​java.lang.String> custom)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • withDescription

        public ProvenanceAction withDescription​(java.lang.String description)

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • setAdditionalProperties

        public void setAdditionalProperties​(java.lang.String name,
                                    java.lang.Object value)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object