/AWS1/CL_OMXGETWORKFLOWRSP¶
GetWorkflowResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_arn TYPE /AWS1/OMXWORKFLOWARN /AWS1/OMXWORKFLOWARN¶
The workflow's ARN.
iv_id TYPE /AWS1/OMXWORKFLOWID /AWS1/OMXWORKFLOWID¶
The workflow's ID.
iv_status TYPE /AWS1/OMXWORKFLOWSTATUS /AWS1/OMXWORKFLOWSTATUS¶
The workflow's status.
iv_type TYPE /AWS1/OMXWORKFLOWTYPE /AWS1/OMXWORKFLOWTYPE¶
The workflow's type.
iv_name TYPE /AWS1/OMXWORKFLOWNAME /AWS1/OMXWORKFLOWNAME¶
The workflow's name.
iv_description TYPE /AWS1/OMXWORKFLOWDESCRIPTION /AWS1/OMXWORKFLOWDESCRIPTION¶
The workflow's description.
iv_engine TYPE /AWS1/OMXWORKFLOWENGINE /AWS1/OMXWORKFLOWENGINE¶
The workflow's engine.
iv_definition TYPE /AWS1/OMXWORKFLOWDEFINITION /AWS1/OMXWORKFLOWDEFINITION¶
The workflow's definition.
iv_main TYPE /AWS1/OMXWORKFLOWMAIN /AWS1/OMXWORKFLOWMAIN¶
The path of the main definition file for the workflow.
iv_digest TYPE /AWS1/OMXWORKFLOWDIGEST /AWS1/OMXWORKFLOWDIGEST¶
The workflow's digest.
it_parametertemplate TYPE /AWS1/CL_OMXWORKFLOWPARAMETER=>TT_WORKFLOWPARAMETERTEMPLATE TT_WORKFLOWPARAMETERTEMPLATE¶
The workflow's parameter template.
iv_storagecapacity TYPE /AWS1/OMXINTEGER /AWS1/OMXINTEGER¶
The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
iv_creationtime TYPE /AWS1/OMXWORKFLOWTIMESTAMP /AWS1/OMXWORKFLOWTIMESTAMP¶
When the workflow was created.
iv_statusmessage TYPE /AWS1/OMXWORKFLOWSTATUSMESSAGE /AWS1/OMXWORKFLOWSTATUSMESSAGE¶
The workflow's status message.
it_tags TYPE /AWS1/CL_OMXTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
The workflow's tags.
it_metadata TYPE /AWS1/CL_OMXWORKFLOWMETADATA_W=>TT_WORKFLOWMETADATA TT_WORKFLOWMETADATA¶
Gets metadata for the workflow.
iv_accelerators TYPE /AWS1/OMXACCELERATORS /AWS1/OMXACCELERATORS¶
The computational accelerator specified to run the workflow.
iv_storagetype TYPE /AWS1/OMXSTORAGETYPE /AWS1/OMXSTORAGETYPE¶
The default storage type for runs using this workflow.
iv_uuid TYPE /AWS1/OMXWORKFLOWUUID /AWS1/OMXWORKFLOWUUID¶
The universally unique identifier (UUID) value for this workflow.
iv_readme TYPE /AWS1/OMXREADMES3PRESIGNEDURL /AWS1/OMXREADMES3PRESIGNEDURL¶
The README content for the workflow, providing documentation and usage information.
io_defnrepositorydetails TYPE REF TO /AWS1/CL_OMXDEFNREPODETAILS /AWS1/CL_OMXDEFNREPODETAILS¶
Details about the source code repository that hosts the workflow definition files.
iv_readmepath TYPE /AWS1/OMXREADMEPATH /AWS1/OMXREADMEPATH¶
The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the
README.mdfile from the root directory of the repository will be used.
Queryable Attributes¶
arn¶
The workflow's ARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
id¶
The workflow's ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
status¶
The workflow's status.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
type¶
The workflow's type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
name¶
The workflow's name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
description¶
The workflow's description.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
engine¶
The workflow's engine.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGINE() |
Getter for ENGINE, with configurable default |
ASK_ENGINE() |
Getter for ENGINE w/ exceptions if field has no value |
HAS_ENGINE() |
Determine if ENGINE has a value |
definition¶
The workflow's definition.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFINITION() |
Getter for DEFINITION, with configurable default |
ASK_DEFINITION() |
Getter for DEFINITION w/ exceptions if field has no value |
HAS_DEFINITION() |
Determine if DEFINITION has a value |
main¶
The path of the main definition file for the workflow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAIN() |
Getter for MAIN, with configurable default |
ASK_MAIN() |
Getter for MAIN w/ exceptions if field has no value |
HAS_MAIN() |
Determine if MAIN has a value |
digest¶
The workflow's digest.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DIGEST() |
Getter for DIGEST, with configurable default |
ASK_DIGEST() |
Getter for DIGEST w/ exceptions if field has no value |
HAS_DIGEST() |
Determine if DIGEST has a value |
parameterTemplate¶
The workflow's parameter template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARAMETERTEMPLATE() |
Getter for PARAMETERTEMPLATE, with configurable default |
ASK_PARAMETERTEMPLATE() |
Getter for PARAMETERTEMPLATE w/ exceptions if field has no v |
HAS_PARAMETERTEMPLATE() |
Determine if PARAMETERTEMPLATE has a value |
storageCapacity¶
The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STORAGECAPACITY() |
Getter for STORAGECAPACITY, with configurable default |
ASK_STORAGECAPACITY() |
Getter for STORAGECAPACITY w/ exceptions if field has no val |
HAS_STORAGECAPACITY() |
Determine if STORAGECAPACITY has a value |
creationTime¶
When the workflow was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
statusMessage¶
The workflow's status message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSMESSAGE() |
Getter for STATUSMESSAGE, with configurable default |
ASK_STATUSMESSAGE() |
Getter for STATUSMESSAGE w/ exceptions if field has no value |
HAS_STATUSMESSAGE() |
Determine if STATUSMESSAGE has a value |
tags¶
The workflow's tags.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
metadata¶
Gets metadata for the workflow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METADATA() |
Getter for METADATA, with configurable default |
ASK_METADATA() |
Getter for METADATA w/ exceptions if field has no value |
HAS_METADATA() |
Determine if METADATA has a value |
accelerators¶
The computational accelerator specified to run the workflow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCELERATORS() |
Getter for ACCELERATORS, with configurable default |
ASK_ACCELERATORS() |
Getter for ACCELERATORS w/ exceptions if field has no value |
HAS_ACCELERATORS() |
Determine if ACCELERATORS has a value |
storageType¶
The default storage type for runs using this workflow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STORAGETYPE() |
Getter for STORAGETYPE, with configurable default |
ASK_STORAGETYPE() |
Getter for STORAGETYPE w/ exceptions if field has no value |
HAS_STORAGETYPE() |
Determine if STORAGETYPE has a value |
uuid¶
The universally unique identifier (UUID) value for this workflow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UUID() |
Getter for UUID, with configurable default |
ASK_UUID() |
Getter for UUID w/ exceptions if field has no value |
HAS_UUID() |
Determine if UUID has a value |
readme¶
The README content for the workflow, providing documentation and usage information.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_README() |
Getter for README, with configurable default |
ASK_README() |
Getter for README w/ exceptions if field has no value |
HAS_README() |
Determine if README has a value |
definitionRepositoryDetails¶
Details about the source code repository that hosts the workflow definition files.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFNREPOSITORYDETAILS() |
Getter for DEFINITIONREPOSITORYDETAILS |
readmePath¶
The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the
README.mdfile from the root directory of the repository will be used.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_READMEPATH() |
Getter for READMEPATH, with configurable default |
ASK_READMEPATH() |
Getter for READMEPATH w/ exceptions if field has no value |
HAS_READMEPATH() |
Determine if READMEPATH has a value |