/AWS1/IF_MDI=>ASSOCIATEFEED()¶
About AssociateFeed¶
Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed.
AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation.
Specifically:
-
You can add more outputs to the existing outputs. New outputs will be appended.
-
You can't modify an existing output (for example to change its name). Instead, use UpdateFeed.
-
You can't delete an existing output. Instead, use UpdateFeed.
Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.
Method Signature¶
METHODS /AWS1/IF_MDI~ASSOCIATEFEED
IMPORTING
!IV_ID TYPE /AWS1/MDIFEEDID OPTIONAL
!IV_ASSOCIATEDRESOURCENAME TYPE /AWS1/MDIASSOCDRESOURCENAME OPTIONAL
!IT_OUTPUTS TYPE /AWS1/CL_MDICREATEOUTPUT=>TT_CREATEOUTPUTLIST OPTIONAL
!IV_DRYRUN TYPE /AWS1/MDIBOOLEAN OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdiassocfeedresponse
RAISING
/AWS1/CX_MDIACCESSDENIEDEX
/AWS1/CX_MDICONFLICTEXCEPTION
/AWS1/CX_MDIINTSERVERERROREX
/AWS1/CX_MDIRESOURCENOTFOUNDEX
/AWS1/CX_MDISERVICEQUOTAEXCDEX
/AWS1/CX_MDITOOMANYREQUESTEX
/AWS1/CX_MDIVLDTNEXCEPTION
/AWS1/CX_MDICLIENTEXC
/AWS1/CX_MDISERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_id TYPE /AWS1/MDIFEEDID /AWS1/MDIFEEDID¶
The ID of the feed.
iv_associatedresourcename TYPE /AWS1/MDIASSOCDRESOURCENAME /AWS1/MDIASSOCDRESOURCENAME¶
An identifier for the resource. This name must not resemble an ARN.
The resource is the source media that the feed will process. The name you assign should help you to later identify the source media that belongs to the feed. In this way, you will know which source media to push to the feed (using PutMedia).
it_outputs TYPE /AWS1/CL_MDICREATEOUTPUT=>TT_CREATEOUTPUTLIST TT_CREATEOUTPUTLIST¶
An array of one or more outputs that you want to add to this feed now, to supplement any outputs that you specified when you created or updated the feed.
Optional arguments:¶
iv_dryrun TYPE /AWS1/MDIBOOLEAN /AWS1/MDIBOOLEAN¶
Set to true if you want to do a dry run of the associate action.
Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions, quota limits exceeded, conflicting outputs, and so on. If the dry run fails, the action returns a 4xx error code. After you've fixed the errors, resubmit the request.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_mdiassocfeedresponse /AWS1/CL_MDIASSOCFEEDRESPONSE¶
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->associatefeed(
it_outputs = VALUE /aws1/cl_mdicreateoutput=>tt_createoutputlist(
(
new /aws1/cl_mdicreateoutput(
io_outputconfig = new /aws1/cl_mdioutputconfig(
io_clipping = new /aws1/cl_mdiclippingconfig( |string| )
io_cropping = new /aws1/cl_mdicroppingconfig( )
io_subtitling = new /aws1/cl_mdisubtitlingconfig(
io_aspectratio = new /aws1/cl_mdiaspectratio(
iv_height = 123
iv_width = 123
)
iv_dictionary = |string|
iv_language = |string|
iv_profanityfilter = |string|
)
)
iv_description = |string|
iv_name = |string|
iv_status = |string|
)
)
)
iv_associatedresourcename = |string|
iv_dryrun = ABAP_TRUE
iv_id = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lv_feedarn = lo_result->get_arn( ).
lv_feedid = lo_result->get_id( ).
ENDIF.