AllowedCloudExtraParameters
is an option for APIFunction and related functions that specifies whether parameters that affect overall cloud execution should be accepted.
Details
- The setting for AllowedCloudExtraParameters can be All, None or a list.
- Typical elements in the setting for AllowedCloudExtraParameters include:
-
"_timeout" equivalent to TimeConstrained "_memorylimit" equivalent to MemoryConstrained "_geolocation" equivalent to setting $GeoLocation "_exportform" equivalent to ExportForm "_responseform" equivalent to ResponseForm - Values for extra parameters are interpreted using the following Interpreter specifications:
-
"_timeout" Restricted["Quantity","Seconds"] "_memorylimit" Restricted["Quantity","Bytes"] "_geolocation" "Location" "_exportform" "ExportFormatString" "_responseform" Restricted["ExportFormatString",…] - The restriction for "_responseform" is {{"XML","JSON","RawJSON","WL","String","Text","HTML","HTMLFragment"}}.
Examples
open all close allBasic Examples (1)
Allow the caller of an APIFunction to set the format used for exporting the result:
If the "_exportform" parameter is not specified in the call, the APIFunction will not export the result:
Scope (5)
When AllowedCloudExtraParameters is set to "_exportform", the response can be exported using any format from $ExportFormats, overriding the specified export format:
When AllowedCloudExtraParameters is set to "_responseform", a ResponseForm of the result can be returned:
When AllowedCloudExtraParameters is set to "_geolocation", the client can specify a different $GeoLocation:
When AllowedCloudExtraParameters is set to "_memorylimit", the client can specify a limit for memory usage:
When AllowedCloudExtraParameters is set to "_timeout", the client can specify a time limit for the execution:
Properties & Relations (2)
Allowing for "_exportform" is effectively equivalent to setting the third argument of APIFunction:
Allowing for "_responseform" is effectively equivalent to wrapping the body of the APIFunction in ResponseForm:
Text
Wolfram Research (2017), AllowedCloudExtraParameters, Wolfram Language function, https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html.
CMS
Wolfram Language. 2017. "AllowedCloudExtraParameters." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html.
APA
Wolfram Language. (2017). AllowedCloudExtraParameters. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html