GETDATAENDPOINT()`¶

About GetDataEndpoint¶

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN.

Method Signature¶

METHODS /AWS1/IF_KNV~GETDATAENDPOINT
  IMPORTING
    !IV_STREAMNAME TYPE /AWS1/KNVSTREAMNAME OPTIONAL
    !IV_STREAMARN TYPE /AWS1/KNVRESOURCEARN OPTIONAL
    !IV_APINAME TYPE /AWS1/KNVAPINAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knvgetdataendptoutput
  RAISING
    /AWS1/CX_KNVCLIENTLIMITEXCDEX
    /AWS1/CX_KNVINVALIDARGUMENTEX
    /AWS1/CX_KNVNOTAUTHORIZEDEX
    /AWS1/CX_KNVRESOURCENOTFOUNDEX
    /AWS1/CX_KNVCLIENTEXC
    /AWS1/CX_KNVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_apiname` `TYPE /AWS1/KNVAPINAME` `/AWS1/KNVAPINAME`¶

The name of the API action for which to get an endpoint.

Optional arguments:¶

`iv_streamname` `TYPE /AWS1/KNVSTREAMNAME` `/AWS1/KNVSTREAMNAME`¶

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

`iv_streamarn` `TYPE /AWS1/KNVRESOURCEARN` `/AWS1/KNVRESOURCEARN`¶

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knvgetdataendptoutput` `/AWS1/CL_KNVGETDATAENDPTOUTPUT`¶

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->getdataendpoint(
  iv_apiname = |string|
  iv_streamarn = |string|
  iv_streamname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_dataendpoint = lo_result->get_dataendpoint( ).
ENDIF.

/AWS1/IF_KNV=>GETDATAENDPOINT()¶