/AWS1/CL_OMXGETBATCHRESPONSE¶
GetBatchResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_id TYPE /AWS1/OMXBATCHID /AWS1/OMXBATCHID¶
The identifier portion of the run batch ARN.
iv_arn TYPE /AWS1/OMXBATCHARN /AWS1/OMXBATCHARN¶
The unique ARN of the run batch.
iv_uuid TYPE /AWS1/OMXBATCHUUID /AWS1/OMXBATCHUUID¶
The universally unique identifier (UUID) for the run batch.
iv_name TYPE /AWS1/OMXBATCHNAME /AWS1/OMXBATCHNAME¶
The optional user-friendly name of the batch.
iv_status TYPE /AWS1/OMXBATCHSTATUS /AWS1/OMXBATCHSTATUS¶
The current status of the run batch.
it_tags TYPE /AWS1/CL_OMXTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
AWS tags associated with the run batch.
iv_totalruns TYPE /AWS1/OMXINTEGER /AWS1/OMXINTEGER¶
The total number of runs in the batch.
io_defaultrunsetting TYPE REF TO /AWS1/CL_OMXDEFAULTRUNSETTING /AWS1/CL_OMXDEFAULTRUNSETTING¶
The shared configuration applied to all runs in the batch. See
DefaultRunSetting.
io_submissionsummary TYPE REF TO /AWS1/CL_OMXSUBMISSIONSUMMARY /AWS1/CL_OMXSUBMISSIONSUMMARY¶
A summary of run submission outcomes. See
SubmissionSummary.
io_runsummary TYPE REF TO /AWS1/CL_OMXRUNSUMMARY /AWS1/CL_OMXRUNSUMMARY¶
A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches
PROCESSEDstatus. SeeRunSummary.
iv_creationtime TYPE /AWS1/OMXBATCHTIMESTAMP /AWS1/OMXBATCHTIMESTAMP¶
The timestamp when the batch was created.
iv_submittedtime TYPE /AWS1/OMXBATCHTIMESTAMP /AWS1/OMXBATCHTIMESTAMP¶
The timestamp when all run submissions completed.
iv_processedtime TYPE /AWS1/OMXBATCHTIMESTAMP /AWS1/OMXBATCHTIMESTAMP¶
The timestamp when all run executions completed.
iv_failedtime TYPE /AWS1/OMXBATCHTIMESTAMP /AWS1/OMXBATCHTIMESTAMP¶
The timestamp when the batch transitioned to a
FAILEDstatus.
iv_failurereason TYPE /AWS1/OMXSTRING /AWS1/OMXSTRING¶
A description of the batch failure. Present only when status is
FAILED.
Queryable Attributes¶
id¶
The identifier portion of the run batch ARN.
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 |
arn¶
The unique ARN of the run batch.
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 |
uuid¶
The universally unique identifier (UUID) for the run batch.
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 |
name¶
The optional user-friendly name of the batch.
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 |
status¶
The current status of the run batch.
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 |
tags¶
AWS tags associated with the run batch.
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 |
totalRuns¶
The total number of runs in the batch.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOTALRUNS() |
Getter for TOTALRUNS, with configurable default |
ASK_TOTALRUNS() |
Getter for TOTALRUNS w/ exceptions if field has no value |
HAS_TOTALRUNS() |
Determine if TOTALRUNS has a value |
defaultRunSetting¶
The shared configuration applied to all runs in the batch. See
DefaultRunSetting.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTRUNSETTING() |
Getter for DEFAULTRUNSETTING |
submissionSummary¶
A summary of run submission outcomes. See
SubmissionSummary.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBMISSIONSUMMARY() |
Getter for SUBMISSIONSUMMARY |
runSummary¶
A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches
PROCESSEDstatus. SeeRunSummary.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RUNSUMMARY() |
Getter for RUNSUMMARY |
creationTime¶
The timestamp when the batch 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 |
submittedTime¶
The timestamp when all run submissions completed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBMITTEDTIME() |
Getter for SUBMITTEDTIME, with configurable default |
ASK_SUBMITTEDTIME() |
Getter for SUBMITTEDTIME w/ exceptions if field has no value |
HAS_SUBMITTEDTIME() |
Determine if SUBMITTEDTIME has a value |
processedTime¶
The timestamp when all run executions completed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROCESSEDTIME() |
Getter for PROCESSEDTIME, with configurable default |
ASK_PROCESSEDTIME() |
Getter for PROCESSEDTIME w/ exceptions if field has no value |
HAS_PROCESSEDTIME() |
Determine if PROCESSEDTIME has a value |
failedTime¶
The timestamp when the batch transitioned to a
FAILEDstatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILEDTIME() |
Getter for FAILEDTIME, with configurable default |
ASK_FAILEDTIME() |
Getter for FAILEDTIME w/ exceptions if field has no value |
HAS_FAILEDTIME() |
Determine if FAILEDTIME has a value |
failureReason¶
A description of the batch failure. Present only when status is
FAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |