GETRESOURCEDASHBOARD()`¶

About GetResourceDashboard¶

Returns a URL that you can use to access the application UIs for a specified resource, such as a session.

For resources in a running state, the application UI is a live user interface such as the Spark web UI. For terminated resources, the application UI is a persistent application user interface such as the Spark History Server.

The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.

Method Signature¶

METHODS /AWS1/IF_EMS~GETRESOURCEDASHBOARD
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/EMSAPPLICATIONID OPTIONAL
    !IV_RESOURCEID TYPE /AWS1/EMSRESOURCEID OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/EMSRESOURCETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_emsgetresdboardrsp
  RAISING
    /AWS1/CX_EMSINTERNALSERVEREX
    /AWS1/CX_EMSRESOURCENOTFOUNDEX
    /AWS1/CX_EMSVALIDATIONEX
    /AWS1/CX_EMSCLIENTEXC
    /AWS1/CX_EMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationid` `TYPE /AWS1/EMSAPPLICATIONID` `/AWS1/EMSAPPLICATIONID`¶

The ID of the application that the resource belongs to.

`iv_resourceid` `TYPE /AWS1/EMSRESOURCEID` `/AWS1/EMSRESOURCEID`¶

The ID of the resource.

`iv_resourcetype` `TYPE /AWS1/EMSRESOURCETYPE` `/AWS1/EMSRESOURCETYPE`¶

The type of resource to access the dashboard for. Currently, only Session is supported.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_emsgetresdboardrsp` `/AWS1/CL_EMSGETRESDBOARDRSP`¶

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->getresourcedashboard(
  iv_applicationid = |string|
  iv_resourceid = |string|
  iv_resourcetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_url = lo_result->get_url( ).
ENDIF.

/AWS1/IF_EMS=>GETRESOURCEDASHBOARD()¶