Skip to content

/AWS1/CL_SNB=>DESCRIBECLUSTER()

About DescribeCluster

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Method Signature

IMPORTING

Required arguments:

iv_clusterid TYPE /AWS1/SNBCLUSTERID /AWS1/SNBCLUSTERID

The automatically generated ID for a cluster.

RETURNING

oo_output TYPE REF TO /aws1/cl_snbdescrclusterresult /AWS1/CL_SNBDESCRCLUSTERRESULT

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->/aws1/if_snb~describecluster( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_clustermetadata = lo_result->get_clustermetadata( ).
  IF lo_clustermetadata IS NOT INITIAL.
    lv_string = lo_clustermetadata->get_clusterid( ).
    lv_string = lo_clustermetadata->get_description( ).
    lv_kmskeyarn = lo_clustermetadata->get_kmskeyarn( ).
    lv_rolearn = lo_clustermetadata->get_rolearn( ).
    lv_clusterstate = lo_clustermetadata->get_clusterstate( ).
    lv_jobtype = lo_clustermetadata->get_jobtype( ).
    lv_snowballtype = lo_clustermetadata->get_snowballtype( ).
    lv_timestamp = lo_clustermetadata->get_creationdate( ).
    lo_jobresource = lo_clustermetadata->get_resources( ).
    IF lo_jobresource IS NOT INITIAL.
      LOOP AT lo_jobresource->get_s3resources( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_resourcearn = lo_row_1->get_bucketarn( ).
          lo_keyrange = lo_row_1->get_keyrange( ).
          IF lo_keyrange IS NOT INITIAL.
            lv_string = lo_keyrange->get_beginmarker( ).
            lv_string = lo_keyrange->get_endmarker( ).
          ENDIF.
          LOOP AT lo_row_1->get_targetondeviceservices( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_deviceservicename = lo_row_3->get_servicename( ).
              lv_transferoption = lo_row_3->get_transferoption( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_jobresource->get_lambdaresources( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_resourcearn = lo_row_5->get_lambdaarn( ).
          LOOP AT lo_row_5->get_eventtriggers( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_resourcearn = lo_row_7->get_eventresourcearn( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_jobresource->get_ec2amiresources( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_amiid = lo_row_9->get_amiid( ).
          lv_string = lo_row_9->get_snowballamiid( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lv_addressid = lo_clustermetadata->get_addressid( ).
    lv_shippingoption = lo_clustermetadata->get_shippingoption( ).
    lo_notification = lo_clustermetadata->get_notification( ).
    IF lo_notification IS NOT INITIAL.
      lv_snstopicarn = lo_notification->get_snstopicarn( ).
      LOOP AT lo_notification->get_jobstatestonotify( ) into lo_row_10.
        lo_row_11 = lo_row_10.
        IF lo_row_11 IS NOT INITIAL.
          lv_jobstate = lo_row_11->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_notification->get_notifyall( ).
      lv_snstopicarn = lo_notification->get_devicepickupsnstopicarn( ).
    ENDIF.
    lv_addressid = lo_clustermetadata->get_forwardingaddressid( ).
    lo_taxdocuments = lo_clustermetadata->get_taxdocuments( ).
    IF lo_taxdocuments IS NOT INITIAL.
      lo_indtaxdocuments = lo_taxdocuments->get_ind( ).
      IF lo_indtaxdocuments IS NOT INITIAL.
        lv_gstin = lo_indtaxdocuments->get_gstin( ).
      ENDIF.
    ENDIF.
    lo_ondeviceserviceconfigur = lo_clustermetadata->get_ondeviceserviceconf( ).
    IF lo_ondeviceserviceconfigur IS NOT INITIAL.
      lo_nfsondeviceserviceconfi = lo_ondeviceserviceconfigur->get_nfsondeviceservice( ).
      IF lo_nfsondeviceserviceconfi IS NOT INITIAL.
        lv_storagelimit = lo_nfsondeviceserviceconfi->get_storagelimit( ).
        lv_storageunit = lo_nfsondeviceserviceconfi->get_storageunit( ).
      ENDIF.
      lo_tgwondeviceserviceconfi = lo_ondeviceserviceconfigur->get_tgwondeviceservice( ).
      IF lo_tgwondeviceserviceconfi IS NOT INITIAL.
        lv_storagelimit = lo_tgwondeviceserviceconfi->get_storagelimit( ).
        lv_storageunit = lo_tgwondeviceserviceconfi->get_storageunit( ).
      ENDIF.
      lo_eksondeviceserviceconfi = lo_ondeviceserviceconfigur->get_eksondeviceservice( ).
      IF lo_eksondeviceserviceconfi IS NOT INITIAL.
        lv_string = lo_eksondeviceserviceconfi->get_kubernetesversion( ).
        lv_string = lo_eksondeviceserviceconfi->get_eksanywhereversion( ).
      ENDIF.
      lo_s3ondeviceserviceconfig = lo_ondeviceserviceconfigur->get_s3ondeviceservice( ).
      IF lo_s3ondeviceserviceconfig IS NOT INITIAL.
        lv_s3storagelimit = lo_s3ondeviceserviceconfig->get_storagelimit( ).
        lv_storageunit = lo_s3ondeviceserviceconfig->get_storageunit( ).
        lv_servicesize = lo_s3ondeviceserviceconfig->get_servicesize( ).
        lv_nodefaulttolerance = lo_s3ondeviceserviceconfig->get_faulttolerance( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.