/AWS1/CL_PTSLSTENGAGEMENTFRM02¶
Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_taskid TYPE /AWS1/PTSTASKIDENTIFIER /AWS1/PTSTASKIDENTIFIER¶
A unique identifier for a specific task.
iv_taskarn TYPE /AWS1/PTSTASKARN /AWS1/PTSTASKARN¶
The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
iv_starttime TYPE /AWS1/PTSDATETIME /AWS1/PTSDATETIME¶
The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
iv_taskstatus TYPE /AWS1/PTSTASKSTATUS /AWS1/PTSTASKSTATUS¶
The current status of the task.
iv_message TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING¶
A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
iv_reasoncode TYPE /AWS1/PTSREASONCODE /AWS1/PTSREASONCODE¶
A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
iv_opportunityid TYPE /AWS1/PTSOPPORTUNITYIDENTIFIER /AWS1/PTSOPPORTUNITYIDENTIFIER¶
The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
iv_resourcesnapshotjobid TYPE /AWS1/PTSRESOURCESNAPSHOTJOBID /AWS1/PTSRESOURCESNAPSHOTJOBID¶
The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
iv_engagementid TYPE /AWS1/PTSENGAGEMENTIDENTIFIER /AWS1/PTSENGAGEMENTIDENTIFIER¶
The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
iv_engagementinvitationid TYPE /AWS1/PTSENGAGEMENTINVITATIO01 /AWS1/PTSENGAGEMENTINVITATIO01¶
The unique identifier of the Engagement Invitation.
Queryable Attributes¶
TaskId¶
A unique identifier for a specific task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKID() |
Getter for TASKID, with configurable default |
ASK_TASKID() |
Getter for TASKID w/ exceptions if field has no value |
HAS_TASKID() |
Determine if TASKID has a value |
TaskArn¶
The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKARN() |
Getter for TASKARN, with configurable default |
ASK_TASKARN() |
Getter for TASKARN w/ exceptions if field has no value |
HAS_TASKARN() |
Determine if TASKARN has a value |
StartTime¶
The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIME() |
Getter for STARTTIME, with configurable default |
ASK_STARTTIME() |
Getter for STARTTIME w/ exceptions if field has no value |
HAS_STARTTIME() |
Determine if STARTTIME has a value |
TaskStatus¶
The current status of the task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKSTATUS() |
Getter for TASKSTATUS, with configurable default |
ASK_TASKSTATUS() |
Getter for TASKSTATUS w/ exceptions if field has no value |
HAS_TASKSTATUS() |
Determine if TASKSTATUS has a value |
Message¶
A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGE() |
Getter for MESSAGE, with configurable default |
ASK_MESSAGE() |
Getter for MESSAGE w/ exceptions if field has no value |
HAS_MESSAGE() |
Determine if MESSAGE has a value |
ReasonCode¶
A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REASONCODE() |
Getter for REASONCODE, with configurable default |
ASK_REASONCODE() |
Getter for REASONCODE w/ exceptions if field has no value |
HAS_REASONCODE() |
Determine if REASONCODE has a value |
OpportunityId¶
The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPPORTUNITYID() |
Getter for OPPORTUNITYID, with configurable default |
ASK_OPPORTUNITYID() |
Getter for OPPORTUNITYID w/ exceptions if field has no value |
HAS_OPPORTUNITYID() |
Determine if OPPORTUNITYID has a value |
ResourceSnapshotJobId¶
The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESNAPSHOTJOBID() |
Getter for RESOURCESNAPSHOTJOBID, with configurable default |
ASK_RESOURCESNAPSHOTJOBID() |
Getter for RESOURCESNAPSHOTJOBID w/ exceptions if field has |
HAS_RESOURCESNAPSHOTJOBID() |
Determine if RESOURCESNAPSHOTJOBID has a value |
EngagementId¶
The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGAGEMENTID() |
Getter for ENGAGEMENTID, with configurable default |
ASK_ENGAGEMENTID() |
Getter for ENGAGEMENTID w/ exceptions if field has no value |
HAS_ENGAGEMENTID() |
Determine if ENGAGEMENTID has a value |
EngagementInvitationId¶
The unique identifier of the Engagement Invitation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGAGEMENTINVITATIONID() |
Getter for ENGAGEMENTINVITATIONID, with configurable default |
ASK_ENGAGEMENTINVITATIONID() |
Getter for ENGAGEMENTINVITATIONID w/ exceptions if field has |
HAS_ENGAGEMENTINVITATIONID() |
Determine if ENGAGEMENTINVITATIONID has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_LSTENGAGEMENTFRMOPPORTUNI00¶
TYPES TT_LSTENGAGEMENTFRMOPPORTUNI00 TYPE STANDARD TABLE OF REF TO /AWS1/CL_PTSLSTENGAGEMENTFRM02 WITH DEFAULT KEY
.