Skip to content

/AWS1/IF_AMF=>STARTJOB()

About StartJob

Starts a new job for a branch of an Amplify app.

Method Signature

METHODS /AWS1/IF_AMF~STARTJOB
  IMPORTING
    !IV_APPID TYPE /AWS1/AMFAPPID OPTIONAL
    !IV_BRANCHNAME TYPE /AWS1/AMFBRANCHNAME OPTIONAL
    !IV_JOBID TYPE /AWS1/AMFJOBID OPTIONAL
    !IV_JOBTYPE TYPE /AWS1/AMFJOBTYPE OPTIONAL
    !IV_JOBREASON TYPE /AWS1/AMFJOBREASON OPTIONAL
    !IV_COMMITID TYPE /AWS1/AMFCOMMITID OPTIONAL
    !IV_COMMITMESSAGE TYPE /AWS1/AMFCOMMITMESSAGE OPTIONAL
    !IV_COMMITTIME TYPE /AWS1/AMFCOMMITTIME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amfstartjobresult
  RAISING
    /AWS1/CX_AMFBADREQUESTEX
    /AWS1/CX_AMFINTERNALFAILUREEX
    /AWS1/CX_AMFLIMITEXCEEDEDEX
    /AWS1/CX_AMFNOTFOUNDEXCEPTION
    /AWS1/CX_AMFUNAUTHORIZEDEX
    /AWS1/CX_AMFCLIENTEXC
    /AWS1/CX_AMFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_appid TYPE /AWS1/AMFAPPID /AWS1/AMFAPPID

The unique ID for an Amplify app.

iv_branchname TYPE /AWS1/AMFBRANCHNAME /AWS1/AMFBRANCHNAME

The name of the branch to use for the job.

iv_jobtype TYPE /AWS1/AMFJOBTYPE /AWS1/AMFJOBTYPE

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Optional arguments:

iv_jobid TYPE /AWS1/AMFJOBID /AWS1/AMFJOBID

The unique ID for an existing job. This is required if the value of jobType is RETRY.

iv_jobreason TYPE /AWS1/AMFJOBREASON /AWS1/AMFJOBREASON

A descriptive reason for starting the job.

iv_commitid TYPE /AWS1/AMFCOMMITID /AWS1/AMFCOMMITID

The commit ID from a third-party repository provider for the job.

iv_commitmessage TYPE /AWS1/AMFCOMMITMESSAGE /AWS1/AMFCOMMITMESSAGE

The commit message from a third-party repository provider for the job.

iv_committime TYPE /AWS1/AMFCOMMITTIME /AWS1/AMFCOMMITTIME

The commit date and time for the job.

RETURNING

oo_output TYPE REF TO /aws1/cl_amfstartjobresult /AWS1/CL_AMFSTARTJOBRESULT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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.

DATA(lo_result) = lo_client->startjob(
  iv_appid = |string|
  iv_branchname = |string|
  iv_commitid = |string|
  iv_commitmessage = |string|
  iv_committime = '20150101000000.0000000'
  iv_jobid = |string|
  iv_jobreason = |string|
  iv_jobtype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_jobsummary = lo_result->get_jobsummary( ).
  IF lo_jobsummary IS NOT INITIAL.
    lv_jobarn = lo_jobsummary->get_jobarn( ).
    lv_jobid = lo_jobsummary->get_jobid( ).
    lv_commitid = lo_jobsummary->get_commitid( ).
    lv_commitmessage = lo_jobsummary->get_commitmessage( ).
    lv_committime = lo_jobsummary->get_committime( ).
    lv_starttime = lo_jobsummary->get_starttime( ).
    lv_jobstatus = lo_jobsummary->get_status( ).
    lv_endtime = lo_jobsummary->get_endtime( ).
    lv_jobtype = lo_jobsummary->get_jobtype( ).
    lv_sourceurl = lo_jobsummary->get_sourceurl( ).
    lv_sourceurltype = lo_jobsummary->get_sourceurltype( ).
  ENDIF.
ENDIF.