Skip to main content

TaskActionSpec

TaskActionSpec defines the desired state of TaskAction

Attributes

AttributeTypeDescription
RunNamestringRunName is the name of the run this action belongs to; it must be between 1 and 30 characters long.
ProjectstringProject this action belongs to; it must be between 1 and 63 characters long.
DomainstringDomain this action belongs to; it must be between 1 and 63 characters long.
ActionNamestringActionName is the unique name of this action within the run; it must be between 1 and 30 characters long.
ParentActionNamestringParentActionName is the optional name of the parent action; it must be between 1 and 30 characters long if set.
InputURIstringInputURI is the path to the input data for this action; it must have a minimum length of 1.
RunOutputBasestringRunOutputBase is the base path where this action should write its output; it must have a minimum length of 1.
CacheKeystringCacheKey enables cache lookup/writeback for this task action when set, propagated from workflow.TaskAction.cache_key; it has a maximum length of 256.
TaskTypestringTaskType identifies which plugin handles this task (e.g. "container", "spark", "ray"); it must be between 1 and 63 characters long.
ShortNamestringShortName is the human-readable display name for this task; it has a maximum length of 63.
TaskTemplatearrayTaskTemplate is the proto-serialized core.TaskTemplate stored inline in etcd.
EnvVarsobjectEnvVars are run-scoped environment variables projected from RunSpec for executor runtime use.
InterruptiblebooleanInterruptible is the run-scoped interruptibility override projected from RunSpec.
GroupstringGroup is the group this action belongs to, if applicable; it has a maximum length of 256.

Constructor

Signature

def TaskActionSpec(
RunName: string,
Project: string,
Domain: string,
ActionName: string,
ParentActionName: string = null,
InputURI: string,
RunOutputBase: string,
CacheKey: string = null,
TaskType: string,
ShortName: string = null,
TaskTemplate: bytes,
EnvVars: map[string]string = null,
Interruptible: boolean = null,
Group: string = null
) - > null

Parameters

NameTypeDescription
RunNamestringThe name of the run this action belongs to. Required, minimum length 1, maximum length 30.
ProjectstringThe project this action belongs to. Required, minimum length 1, maximum length 63.
DomainstringThe domain this action belongs to. Required, minimum length 1, maximum length 63.
ActionNamestringThe unique name of this action within the run. Required, minimum length 1, maximum length 30.
ParentActionNamestring = nullThe optional name of the parent action. Minimum length 1, maximum length 30.
InputURIstringThe path to the input data for this action. Required, minimum length 1.
RunOutputBasestringThe base path where this action should write its output. Required, minimum length 1.
CacheKeystring = nullEnables cache lookup/writeback for this task action when set. Propagated from workflow.TaskAction.cache_key. Maximum length 256.
TaskTypestringIdentifies which plugin handles this task (e.g., 'container', 'spark', 'ray'). Required, minimum length 1, maximum length 63.
ShortNamestring = nullThe human-readable display name for this task. Maximum length 63.
TaskTemplatebytesThe proto-serialized core.TaskTemplate stored inline in etcd. Required.
EnvVarsmap[string]string = nullRun-scoped environment variables projected from RunSpec for executor runtime use.
Interruptibleboolean = nullThe run-scoped interruptibility override projected from RunSpec.
Groupstring = nullThe group this action belongs to, if applicable. Maximum length 256.

Methods


GetActionSpec()

@classmethod
def GetActionSpec() - > *workflow.ActionSpec, error

Retrieves the action specification.

Returns

TypeDescription
*workflow.ActionSpec, errorThe action specification and an error, if any.

SetActionSpec()

@classmethod
def SetActionSpec(
spec: *workflow.ActionSpec
) - > error

Sets the action specification.

Parameters

NameTypeDescription
spec*workflow.ActionSpecThe action specification to set.

Returns

TypeDescription
errorAn error, if any occurred during the setting process.