CANCELHARVESTJOB()`¶

About CancelHarvestJob¶

Cancels an in-progress harvest job.

Method Signature¶

METHODS /AWS1/IF_MD2~CANCELHARVESTJOB
  IMPORTING
    !IV_CHANNELGROUPNAME TYPE /AWS1/MD2RESOURCENAME OPTIONAL
    !IV_CHANNELNAME TYPE /AWS1/MD2RESOURCENAME OPTIONAL
    !IV_ORIGINENDPOINTNAME TYPE /AWS1/MD2RESOURCENAME OPTIONAL
    !IV_HARVESTJOBNAME TYPE /AWS1/MD2RESOURCENAME OPTIONAL
    !IV_ETAG TYPE /AWS1/MD2ENTITYTAG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_md2cancharvestjobrsp
  RAISING
    /AWS1/CX_MD2ACCESSDENIEDEX
    /AWS1/CX_MD2CONFLICTEXCEPTION
    /AWS1/CX_MD2INTERNALSERVEREX
    /AWS1/CX_MD2RESOURCENOTFOUNDEX
    /AWS1/CX_MD2THROTTLINGEX
    /AWS1/CX_MD2VALIDATIONEX
    /AWS1/CX_MD2CLIENTEXC
    /AWS1/CX_MD2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_channelgroupname` `TYPE /AWS1/MD2RESOURCENAME` `/AWS1/MD2RESOURCENAME`¶

The name of the channel group containing the channel from which the harvest job is running.

`iv_channelname` `TYPE /AWS1/MD2RESOURCENAME` `/AWS1/MD2RESOURCENAME`¶

The name of the channel from which the harvest job is running.

`iv_originendpointname` `TYPE /AWS1/MD2RESOURCENAME` `/AWS1/MD2RESOURCENAME`¶

The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.

`iv_harvestjobname` `TYPE /AWS1/MD2RESOURCENAME` `/AWS1/MD2RESOURCENAME`¶

The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.

Optional arguments:¶

`iv_etag` `TYPE /AWS1/MD2ENTITYTAG` `/AWS1/MD2ENTITYTAG`¶

The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_md2cancharvestjobrsp` `/AWS1/CL_MD2CANCHARVESTJOBRSP`¶

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->cancelharvestjob(
  iv_channelgroupname = |string|
  iv_channelname = |string|
  iv_etag = |string|
  iv_harvestjobname = |string|
  iv_originendpointname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

Cancel a Harvest Job¶

Cancel a Harvest Job

DATA(lo_result) = lo_client->cancelharvestjob(
  iv_channelgroupname = |exampleChannelGroup|
  iv_channelname = |exampleChannelName|
  iv_harvestjobname = |HarvestJobName|
  iv_originendpointname = |exampleOriginEndpointName|
).

/AWS1/IF_MD2=>CANCELHARVESTJOB()¶