/AWS1/IF_KFK=>DESCRIBECHANNEL()

About DescribeChannel

Returns the current configuration and state of a channel.

Method Signature

METHODS /AWS1/IF_KFK~DESCRIBECHANNEL
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/KFK__STRING OPTIONAL
    !IV_CLUSTERARN TYPE /AWS1/KFK__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kfkdescrchannelrsp
  RAISING
    /AWS1/CX_KFKBADREQUESTEX
    /AWS1/CX_KFKFORBIDDENEXCEPTION
    /AWS1/CX_KFKINTERNALSERVERER00
    /AWS1/CX_KFKNOTFOUNDEXCEPTION
    /AWS1/CX_KFKSERVICEUNAVAILEX
    /AWS1/CX_KFKTOOMANYREQUESTSEX
    /AWS1/CX_KFKUNAUTHORIZEDEX
    /AWS1/CX_KFKCLIENTEXC
    /AWS1/CX_KFKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_channelarn TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING

The Amazon Resource Name (ARN) that uniquely identifies the channel.

iv_clusterarn TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

RETURNING

oo_output TYPE REF TO /aws1/cl_kfkdescrchannelrsp /AWS1/CL_KFKDESCRCHANNELRSP

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->describechannel(
  iv_channelarn = |string|
  iv_clusterarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv___string = lo_result->get_channelarn( ).
  lv___string = lo_result->get_channelname( ).
  lo_encryptionconfiguration = lo_result->get_encryptionconfiguration( ).
  IF lo_encryptionconfiguration IS NOT INITIAL.
    lv___string = lo_encryptionconfiguration->get_kmskeyarn( ).
  ENDIF.
  lo_icebergdestinationconfi = lo_result->get_icebergdestinationconf( ).
  IF lo_icebergdestinationconfi IS NOT INITIAL.
    lv___boolean = lo_icebergdestinationconfi->get_appendonly( ).
    lo_catalog = lo_icebergdestinationconfi->get_catalog( ).
    IF lo_catalog IS NOT INITIAL.
      lv___string = lo_catalog->get_catalogarn( ).
      lv___string = lo_catalog->get_warehouselocation( ).
    ENDIF.
    lv___integer = lo_icebergdestinationconfi->get_datafreshnessinseconds( ).
    lo_deadletterqueues3 = lo_icebergdestinationconfi->get_deadletterqueues3( ).
    IF lo_deadletterqueues3 IS NOT INITIAL.
      lv___string = lo_deadletterqueues3->get_bucketarn( ).
      lv___string = lo_deadletterqueues3->get_erroroutputprefix( ).
      lv___string = lo_deadletterqueues3->get_expectedbucketowner( ).
    ENDIF.
    LOOP AT lo_icebergdestinationconfi->get_destinationtablelist( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv___string = lo_row_1->get_destinationdatabasename( ).
        lv___string = lo_row_1->get_destinationtablename( ).
        lo_partitionspec = lo_row_1->get_partitionspec( ).
        IF lo_partitionspec IS NOT INITIAL.
          lv_partitionstrategy = lo_partitionspec->get_partitionstrategy( ).
          LOOP AT lo_partitionspec->get_sourcelist( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv___string = lo_row_3->get_sourcename( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDLOOP.
    lo_schemaevolution = lo_icebergdestinationconfi->get_schemaevolution( ).
    IF lo_schemaevolution IS NOT INITIAL.
      lv___boolean = lo_schemaevolution->get_enableschemaevolution( ).
    ENDIF.
    lv___string = lo_icebergdestinationconfi->get_serviceexecutionrolearn( ).
    lo_tablecreation = lo_icebergdestinationconfi->get_tablecreation( ).
    IF lo_tablecreation IS NOT INITIAL.
      lv___boolean = lo_tablecreation->get_enabletablecreation( ).
    ENDIF.
    lv_icebergcompressiontype = lo_icebergdestinationconfi->get_compressiontype( ).
  ENDIF.
  lo_s3destinationconfigurat = lo_result->get_s3destinationconf( ).
  IF lo_s3destinationconfigurat IS NOT INITIAL.
    lv___integer = lo_s3destinationconfigurat->get_datafreshnessinseconds( ).
    lo_deadletterqueues3 = lo_s3destinationconfigurat->get_deadletterqueues3( ).
    IF lo_deadletterqueues3 IS NOT INITIAL.
      lv___string = lo_deadletterqueues3->get_bucketarn( ).
      lv___string = lo_deadletterqueues3->get_erroroutputprefix( ).
      lv___string = lo_deadletterqueues3->get_expectedbucketowner( ).
    ENDIF.
    lv___string = lo_s3destinationconfigurat->get_serviceexecutionrolearn( ).
    lo_s3storage = lo_s3destinationconfigurat->get_storage( ).
    IF lo_s3storage IS NOT INITIAL.
      lv___string = lo_s3storage->get_bucketarn( ).
      lv_s3compressiontype = lo_s3storage->get_compressiontype( ).
      lv___string = lo_s3storage->get_outputprefix( ).
      lv___string = lo_s3storage->get_outputkeytemplate( ).
      lv_s3storageclass = lo_s3storage->get_storageclass( ).
      lv___string = lo_s3storage->get_expectedbucketowner( ).
    ENDIF.
  ENDIF.
  lv_channelstatus = lo_result->get_status( ).
  lv_channeldestinationtype = lo_result->get_destinationtype( ).
  lv___timestampiso8601 = lo_result->get_creationtime( ).
  LOOP AT lo_result->get_topicconfigurationlist( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lo_recordconverter = lo_row_5->get_recordconverter( ).
      IF lo_recordconverter IS NOT INITIAL.
        lv_valueconverter = lo_recordconverter->get_valueconverter( ).
      ENDIF.
      lo_recordschema = lo_row_5->get_recordschema( ).
      IF lo_recordschema IS NOT INITIAL.
        lv___string = lo_recordschema->get_gsrarn( ).
      ENDIF.
      lv___string = lo_row_5->get_topicarn( ).
    ENDIF.
  ENDLOOP.
  lo_channellogginginfo = lo_result->get_logginginfo( ).
  IF lo_channellogginginfo IS NOT INITIAL.
    lo_cloudwatchlogs = lo_channellogginginfo->get_cloudwatchlogs( ).
    IF lo_cloudwatchlogs IS NOT INITIAL.
      lv___boolean = lo_cloudwatchlogs->get_enabled( ).
      lv___string = lo_cloudwatchlogs->get_loggroup( ).
    ENDIF.
    lo_firehose = lo_channellogginginfo->get_firehose( ).
    IF lo_firehose IS NOT INITIAL.
      lv___string = lo_firehose->get_deliverystream( ).
      lv___boolean = lo_firehose->get_enabled( ).
    ENDIF.
    lo_s3 = lo_channellogginginfo->get_s3( ).
    IF lo_s3 IS NOT INITIAL.
      lv___string = lo_s3->get_bucket( ).
      lv___boolean = lo_s3->get_enabled( ).
      lv___string = lo_s3->get_prefix( ).
    ENDIF.
  ENDIF.
  lo_channelstateinfo = lo_result->get_stateinfo( ).
  IF lo_channelstateinfo IS NOT INITIAL.
    lv___string = lo_channelstateinfo->get_code( ).
    lv___string = lo_channelstateinfo->get_message( ).
  ENDIF.
  lv___string = lo_result->get_clusteroperationarn( ).
  LOOP AT lo_result->get_tags( ) into ls_row_6.
    lv_key = ls_row_6-key.
    lo_value = ls_row_6-value.
    IF lo_value IS NOT INITIAL.
      lv___string = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.