DRAINSESSIONINSTANCE()`¶

About DrainSessionInstance¶

Drains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once all sessions end, the instance is reclaimed and replaced. This only applies to multi-session fleets.

Method Signature¶

METHODS /AWS1/IF_APS~DRAINSESSIONINSTANCE
  IMPORTING
    !IV_SESSIONID TYPE /AWS1/APSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apsdrainsessinstrslt
  RAISING
    /AWS1/CX_APSCONCURRENTMODEX
    /AWS1/CX_APSOPNOTPERMITTEDEX
    /AWS1/CX_APSRESOURCENOTFOUNDEX
    /AWS1/CX_APSCLIENTEXC
    /AWS1/CX_APSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_sessionid` `TYPE /AWS1/APSSTRING` `/AWS1/APSSTRING`¶

The identifier of the streaming session.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_apsdrainsessinstrslt` `/AWS1/CL_APSDRAINSESSINSTRSLT`¶

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

This is an example of reading all possible response values

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

/AWS1/IF_APS=>DRAINSESSIONINSTANCE()¶