DESCRIBECOPYJOB()`¶

About DescribeCopyJob¶

Returns metadata associated with creating a copy of a resource.

Method Signature¶

METHODS /AWS1/IF_BUP~DESCRIBECOPYJOB
  IMPORTING
    !IV_COPYJOBID TYPE /AWS1/BUPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bupdescrcopyjoboutput
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPMISSINGPARAMVALEX
    /AWS1/CX_BUPRESOURCENOTFOUNDEX
    /AWS1/CX_BUPSERVICEUNAVAILEX
    /AWS1/CX_BUPCLIENTEXC
    /AWS1/CX_BUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_copyjobid` `TYPE /AWS1/BUPSTRING` `/AWS1/BUPSTRING`¶

Uniquely identifies a copy job.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bupdescrcopyjoboutput` `/AWS1/CL_BUPDESCRCOPYJOBOUTPUT`¶

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->describecopyjob( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_copyjob = lo_result->get_copyjob( ).
  IF lo_copyjob IS NOT INITIAL.
    lv_accountid = lo_copyjob->get_accountid( ).
    lv_string = lo_copyjob->get_copyjobid( ).
    lv_arn = lo_copyjob->get_sourcebackupvaultarn( ).
    lv_arn = lo_copyjob->get_sourcerecoverypointarn( ).
    lv_arn = lo_copyjob->get_dstbackupvaultarn( ).
    lv_string = lo_copyjob->get_destinationvaulttype( ).
    lv_string = lo_copyjob->get_dstvaultlockstate( ).
    lv_arn = lo_copyjob->get_dstrecoverypointarn( ).
    lv_arn = lo_copyjob->get_dstencryptionkeyarn( ).
    lo_lifecycle = lo_copyjob->get_dstrecoverypointlc( ).
    IF lo_lifecycle IS NOT INITIAL.
      lv_long = lo_lifecycle->get_movetocoldstrgafterdays( ).
      lv_long = lo_lifecycle->get_deleteafterdays( ).
      lv_boolean = lo_lifecycle->get_optintoarchiveforsuppe00( ).
      lv_lifecycledeleteaftereve = lo_lifecycle->get_deleteafterevent( ).
    ENDIF.
    lv_arn = lo_copyjob->get_resourcearn( ).
    lv_timestamp = lo_copyjob->get_creationdate( ).
    lv_timestamp = lo_copyjob->get_completiondate( ).
    lv_copyjobstate = lo_copyjob->get_state( ).
    lv_string = lo_copyjob->get_statusmessage( ).
    lv_long = lo_copyjob->get_backupsizeinbytes( ).
    lv_iamrolearn = lo_copyjob->get_iamrolearn( ).
    lo_recoverypointcreator = lo_copyjob->get_createdby( ).
    IF lo_recoverypointcreator IS NOT INITIAL.
      lv_string = lo_recoverypointcreator->get_backupplanid( ).
      lv_arn = lo_recoverypointcreator->get_backupplanarn( ).
      lv_string = lo_recoverypointcreator->get_backupplanname( ).
      lv_string = lo_recoverypointcreator->get_backupplanversion( ).
      lv_string = lo_recoverypointcreator->get_backupruleid( ).
      lv_string = lo_recoverypointcreator->get_backuprulename( ).
      lv_string = lo_recoverypointcreator->get_backuprulecron( ).
      lv_string = lo_recoverypointcreator->get_backupruletimezone( ).
    ENDIF.
    lv_string = lo_copyjob->get_createdbybackupjobid( ).
    lv_resourcetype = lo_copyjob->get_resourcetype( ).
    lv_string = lo_copyjob->get_parentjobid( ).
    lv_boolean2 = lo_copyjob->get_isparent( ).
    lv_string = lo_copyjob->get_compositememberid( ).
    lv_long = lo_copyjob->get_numberofchildjobs( ).
    LOOP AT lo_copyjob->get_childjobsinstate( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_long = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_copyjob->get_resourcename( ).
    lv_string = lo_copyjob->get_messagecategory( ).
  ENDIF.
ENDIF.

/AWS1/IF_BUP=>DESCRIBECOPYJOB()¶