Skip to content

/AWS1/CL_PIP=>PUTJOBSUCCESSRESULT()

About PutJobSuccessResult

Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.

Method Signature

IMPORTING

Required arguments:

iv_jobid TYPE /AWS1/PIPJOBID /AWS1/PIPJOBID

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Optional arguments:

io_currentrevision TYPE REF TO /AWS1/CL_PIPCURRENTREVISION /AWS1/CL_PIPCURRENTREVISION

The ID of the current revision of the artifact successfully worked on by the job.

iv_continuationtoken TYPE /AWS1/PIPCONTINUATIONTOKEN /AWS1/PIPCONTINUATIONTOKEN

A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

io_executiondetails TYPE REF TO /AWS1/CL_PIPEXECUTIONDETAILS /AWS1/CL_PIPEXECUTIONDETAILS

The execution details of the successful job, such as the actions taken by the job worker.

it_outputvariables TYPE /AWS1/CL_PIPOUTVARIABLESMAP_W=>TT_OUTPUTVARIABLESMAP TT_OUTPUTVARIABLESMAP

Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->/aws1/if_pip~putjobsuccessresult(
  io_currentrevision = new /aws1/cl_pipcurrentrevision(
    iv_changeidentifier = |string|
    iv_created = '20150101000000.0000000'
    iv_revision = |string|
    iv_revisionsummary = |string|
  )
  io_executiondetails = new /aws1/cl_pipexecutiondetails(
    iv_externalexecutionid = |string|
    iv_percentcomplete = 123
    iv_summary = |string|
  )
  it_outputvariables = VALUE /aws1/cl_pipoutvariablesmap_w=>tt_outputvariablesmap(
    (
      VALUE /aws1/cl_pipoutvariablesmap_w=>ts_outputvariablesmap_maprow(
        value = new /aws1/cl_pipoutvariablesmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_continuationtoken = |string|
  iv_jobid = |string|
).