GETKXVOLUME()`¶

About GetKxVolume¶

Retrieves the information about the volume.

Method Signature¶

METHODS /AWS1/IF_FNS~GETKXVOLUME
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/FNSKXENVIRONMENTID OPTIONAL
    !IV_VOLUMENAME TYPE /AWS1/FNSKXVOLUMENAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fnsgetkxvolumersp
  RAISING
    /AWS1/CX_FNSACCESSDENIEDEX
    /AWS1/CX_FNSCONFLICTEXCEPTION
    /AWS1/CX_FNSINTERNALSERVEREX
    /AWS1/CX_FNSLIMITEXCEEDEDEX
    /AWS1/CX_FNSRESOURCENOTFOUNDEX
    /AWS1/CX_FNSTHROTTLINGEX
    /AWS1/CX_FNSVALIDATIONEX
    /AWS1/CX_FNSCLIENTEXC
    /AWS1/CX_FNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_environmentid` `TYPE /AWS1/FNSKXENVIRONMENTID` `/AWS1/FNSKXENVIRONMENTID`¶

A unique identifier for the kdb environment, whose clusters can attach to the volume.

`iv_volumename` `TYPE /AWS1/FNSKXVOLUMENAME` `/AWS1/FNSKXVOLUMENAME`¶

A unique identifier for the volume.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fnsgetkxvolumersp` `/AWS1/CL_FNSGETKXVOLUMERSP`¶

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->getkxvolume(
  iv_environmentid = |string|
  iv_volumename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_kxenvironmentid = lo_result->get_environmentid( ).
  lv_kxvolumename = lo_result->get_volumename( ).
  lv_kxvolumetype = lo_result->get_volumetype( ).
  lv_kxvolumearn = lo_result->get_volumearn( ).
  lo_kxnas1configuration = lo_result->get_nas1configuration( ).
  IF lo_kxnas1configuration IS NOT INITIAL.
    lv_kxnas1type = lo_kxnas1configuration->get_type( ).
    lv_kxnas1size = lo_kxnas1configuration->get_size( ).
  ENDIF.
  lv_kxvolumestatus = lo_result->get_status( ).
  lv_kxvolumestatusreason = lo_result->get_statusreason( ).
  lv_timestamp = lo_result->get_createdtimestamp( ).
  lv_description = lo_result->get_description( ).
  lv_kxazmode = lo_result->get_azmode( ).
  LOOP AT lo_result->get_availabilityzoneids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_availabilityzoneid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_timestamp = lo_result->get_lastmodifiedtimestamp( ).
  LOOP AT lo_result->get_attachedclusters( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_kxclustername = lo_row_3->get_clustername( ).
      lv_kxclustertype = lo_row_3->get_clustertype( ).
      lv_kxclusterstatus = lo_row_3->get_clusterstatus( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_FNS=>GETKXVOLUME()¶