STOPAPPLICATION()`¶

About StopApplication¶

Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true.

You can use the DescribeApplication operation to find the application status.

Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set to true.

Method Signature¶

METHODS /AWS1/IF_KN2~STOPAPPLICATION
  IMPORTING
    !IV_APPLICATIONNAME TYPE /AWS1/KN2APPLICATIONNAME OPTIONAL
    !IV_FORCE TYPE /AWS1/KN2BOOLEANOBJECT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kn2stopapplicationrsp
  RAISING
    /AWS1/CX_KN2CONCURRENTMODEX
    /AWS1/CX_KN2INVAPPLICATIONCO00
    /AWS1/CX_KN2INVALIDARGUMENTEX
    /AWS1/CX_KN2INVALIDREQUESTEX
    /AWS1/CX_KN2RESOURCEINUSEEX
    /AWS1/CX_KN2RESOURCENOTFOUNDEX
    /AWS1/CX_KN2CLIENTEXC
    /AWS1/CX_KN2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationname` `TYPE /AWS1/KN2APPLICATIONNAME` `/AWS1/KN2APPLICATIONNAME`¶

The name of the running application to stop.

Optional arguments:¶

`iv_force` `TYPE /AWS1/KN2BOOLEANOBJECT` `/AWS1/KN2BOOLEANOBJECT`¶

Set to true to force the application to stop. If you set Force to true, Managed Service for Apache Flink stops the application without taking a snapshot.

Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.

You can only force stop a Managed Service for Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics application.

The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or RUNNING status.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_kn2stopapplicationrsp` `/AWS1/CL_KN2STOPAPPLICATIONRSP`¶

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->stopapplication(
  iv_applicationname = |string|
  iv_force = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_operationid = lo_result->get_operationid( ).
ENDIF.

/AWS1/IF_KN2=>STOPAPPLICATION()¶