GETSTREAM()`¶

About GetStream¶

Retrieves information about a stream.

Method Signature¶

METHODS /AWS1/IF_XDD~GETSTREAM
  IMPORTING
    !IV_CLUSTERIDENTIFIER TYPE /AWS1/XDDCLUSTERID OPTIONAL
    !IV_STREAMIDENTIFIER TYPE /AWS1/XDDSTREAMID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_xddgetstreamoutput
  RAISING
    /AWS1/CX_XDDACCESSDENIEDEX
    /AWS1/CX_XDDINTERNALSERVEREX
    /AWS1/CX_XDDTHROTTLINGEX
    /AWS1/CX_XDDVALIDATIONEX
    /AWS1/CX_XDDRESOURCENOTFOUNDEX
    /AWS1/CX_XDDCLIENTEXC
    /AWS1/CX_XDDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_clusteridentifier` `TYPE /AWS1/XDDCLUSTERID` `/AWS1/XDDCLUSTERID`¶

The ID of the cluster containing the stream to retrieve.

`iv_streamidentifier` `TYPE /AWS1/XDDSTREAMID` `/AWS1/XDDSTREAMID`¶

The ID of the stream to retrieve.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_xddgetstreamoutput` `/AWS1/CL_XDDGETSTREAMOUTPUT`¶

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->getstream(
  iv_clusteridentifier = |string|
  iv_streamidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_clusterid = lo_result->get_clusteridentifier( ).
  lv_streamid = lo_result->get_streamidentifier( ).
  lv_streamarn = lo_result->get_arn( ).
  lv_streamstatus = lo_result->get_status( ).
  lv_streamcreationtime = lo_result->get_creationtime( ).
  lv_streamordering = lo_result->get_ordering( ).
  lv_streamformat = lo_result->get_format( ).
  lo_targetdefinition = lo_result->get_targetdefinition( ).
  IF lo_targetdefinition IS NOT INITIAL.
    lo_kinesistargetdefinition = lo_targetdefinition->get_kinesis( ).
    IF lo_kinesistargetdefinition IS NOT INITIAL.
      lv_kinesisstreamarn = lo_kinesistargetdefinition->get_streamarn( ).
      lv_rolearn = lo_kinesistargetdefinition->get_rolearn( ).
    ENDIF.
  ENDIF.
  lo_statusreason = lo_result->get_statusreason( ).
  IF lo_statusreason IS NOT INITIAL.
    lv_streamfailureerrorcode = lo_statusreason->get_error( ).
    lv_timestamp = lo_statusreason->get_updatedat( ).
  ENDIF.
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_XDD=>GETSTREAM()¶