Skip to content

/AWS1/IF_SGG=>GETTILE()

About GetTile

Gets a web mercator tile for the given Earth Observation job.

Method Signature

METHODS /AWS1/IF_SGG~GETTILE
  IMPORTING
    !IV_X TYPE /AWS1/SGGINTEGER OPTIONAL
    !IV_Y TYPE /AWS1/SGGINTEGER OPTIONAL
    !IV_Z TYPE /AWS1/SGGINTEGER OPTIONAL
    !IT_IMAGEASSETS TYPE /AWS1/CL_SGGSTRINGLISTINPUT_W=>TT_STRINGLISTINPUT OPTIONAL
    !IV_TARGET TYPE /AWS1/SGGTARGETOPTIONS OPTIONAL
    !IV_ARN TYPE /AWS1/SGGEARTHOBSERVATIONJOB00 OPTIONAL
    !IV_IMAGEMASK TYPE /AWS1/SGGBOOLEAN OPTIONAL
    !IV_OUTPUTFORMAT TYPE /AWS1/SGGSTRING OPTIONAL
    !IV_TIMERANGEFILTER TYPE /AWS1/SGGSTRING OPTIONAL
    !IV_PROPERTYFILTERS TYPE /AWS1/SGGSTRING OPTIONAL
    !IV_OUTPUTDATATYPE TYPE /AWS1/SGGOUTPUTTYPE OPTIONAL
    !IV_EXECUTIONROLEARN TYPE /AWS1/SGGEXECUTIONROLEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgggettileoutput
  RAISING
    /AWS1/CX_SGGACCESSDENIEDEX
    /AWS1/CX_SGGINTERNALSERVEREX
    /AWS1/CX_SGGRESOURCENOTFOUNDEX
    /AWS1/CX_SGGTHROTTLINGEX
    /AWS1/CX_SGGVALIDATIONEX
    /AWS1/CX_SGGCLIENTEXC
    /AWS1/CX_SGGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_x TYPE /AWS1/SGGINTEGER /AWS1/SGGINTEGER

The x coordinate of the tile input.

iv_y TYPE /AWS1/SGGINTEGER /AWS1/SGGINTEGER

The y coordinate of the tile input.

iv_z TYPE /AWS1/SGGINTEGER /AWS1/SGGINTEGER

The z coordinate of the tile input.

it_imageassets TYPE /AWS1/CL_SGGSTRINGLISTINPUT_W=>TT_STRINGLISTINPUT TT_STRINGLISTINPUT

The particular assets or bands to tile.

iv_target TYPE /AWS1/SGGTARGETOPTIONS /AWS1/SGGTARGETOPTIONS

Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

iv_arn TYPE /AWS1/SGGEARTHOBSERVATIONJOB00 /AWS1/SGGEARTHOBSERVATIONJOB00

The Amazon Resource Name (ARN) of the tile operation.

Optional arguments:

iv_imagemask TYPE /AWS1/SGGBOOLEAN /AWS1/SGGBOOLEAN

Determines whether or not to return a valid data mask.

iv_outputformat TYPE /AWS1/SGGSTRING /AWS1/SGGSTRING

The data format of the output tile. The formats include .npy, .png and .jpg.

iv_timerangefilter TYPE /AWS1/SGGSTRING /AWS1/SGGSTRING

Time range filter applied to imagery to find the images to tile.

iv_propertyfilters TYPE /AWS1/SGGSTRING /AWS1/SGGSTRING

Property filters for the imagery to tile.

iv_outputdatatype TYPE /AWS1/SGGOUTPUTTYPE /AWS1/SGGOUTPUTTYPE

The output data type of the tile operation.

iv_executionrolearn TYPE /AWS1/SGGEXECUTIONROLEARN /AWS1/SGGEXECUTIONROLEARN

The Amazon Resource Name (ARN) of the IAM role that you specify.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgggettileoutput /AWS1/CL_SGGGETTILEOUTPUT

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->gettile(
  it_imageassets = VALUE /aws1/cl_sggstringlistinput_w=>tt_stringlistinput(
    ( new /aws1/cl_sggstringlistinput_w( |string| ) )
  )
  iv_arn = |string|
  iv_executionrolearn = |string|
  iv_imagemask = ABAP_TRUE
  iv_outputdatatype = |string|
  iv_outputformat = |string|
  iv_propertyfilters = |string|
  iv_target = |string|
  iv_timerangefilter = |string|
  iv_x = 123
  iv_y = 123
  iv_z = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_binaryfile = lo_result->get_binaryfile( ).
ENDIF.