![]() |
Qore Sap4HanaRestClient Module Reference
1.0
|
class for SAP S/4Hana REST connections; returns Sap4HanaRestClient::Sap4HanaRestClient objects More...

Public Member Functions | |
| deprecated | constructor (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh) |
| DEPRECATED: creates the Sap4HanaRestConnection object. More... | |
| constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) | |
| creates the Sap4HanaRestConnection object More... | |
| *hash< auto > | getDefaultOptions () |
| returns default options | |
| hash< auto > | getOptions () |
| gets options More... | |
| string | getType () |
returns "sap4hanarest" | |
Static Public Member Functions | |
| static deprecated Sap4HanaRestConnection | make (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh) |
| DEPRECATED: static constructor. More... | |
Public Attributes | |
| const | Options |
| Sap4HanaRestConnection object connection options. | |
Protected Member Functions | |
| Sap4HanaRestClient | getImpl (bool connect=True, *hash< auto > rtopts) |
| returns a Sap4HanaRestClient::Sap4HanaRestClient object More... | |
class for SAP S/4Hana REST connections; returns Sap4HanaRestClient::Sap4HanaRestClient objects
supports the following options:
"apikey": (required if "client_id" and "client_secret" are not supplied) the SAP S/4Hana api key"client_id": (required if "apikey" is not supplied) the SAP S/4Hana OAuth2 client ID"client_secret": (required if "apikey" is not supplied) the SAP S/4Hana OAuth2 client secret"connect_timeout": connection timeout to use in milliseconds"content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport"data": see DataSerializationOptions for possible values; the default is "json" "error_passthru": if True then HTTP status codes indicating errors will not cause a REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response"http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")"max_redirects": maximum redirects to support"proxy": proxy URL to use"redirect_passthru": if True then redirect responses will be passed to the caller instead of processed"send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies"timeout": transfer timeout to use in milliseconds| deprecated Sap4HanaRestClient::Sap4HanaRestConnection::constructor | ( | string | name, |
| string | desc, | ||
| string | url, | ||
| bool | monitor, | ||
| *hash< auto > | opts, | ||
| hash< auto > | urlh | ||
| ) |
DEPRECATED: creates the Sap4HanaRestConnection object.
| name | the name of the connection |
| desc | connection description |
| url | connection URL (potentially with password info) |
| monitor | monitoring flag |
| opts | connection options |
| urlh | broken down URL hash (as returned by Qore::parse_url()) |
| SAP4HANARESTCONNECTION-ERROR | missing apikey option |
| Sap4HanaRestClient::Sap4HanaRestConnection::constructor | ( | string | name, |
| string | description, | ||
| string | url, | ||
| hash< auto > | attributes = {}, |
||
| hash< auto > | options = {} |
||
| ) |
creates the Sap4HanaRestConnection object
| name | the name of the connection |
| description | connection description |
| url | connection URL (potentially with password info) |
| attributes | various attributes. See below |
| options | connection options |
See AbstractConnection::constructor() for attributes and options reference.
| SAP4HANARESTCONNECTION-ERROR | missing apikey option |
|
protected |
returns a Sap4HanaRestClient::Sap4HanaRestClient object
| connect | if True, then the connection is returned already connected |
| rtopts | this connection type does not accept any runtime options, so this parameter is ignored |
| hash<auto> Sap4HanaRestClient::Sap4HanaRestConnection::getOptions | ( | ) |
gets options
"apikey": the SAP S/4Hana API key in use"connect_timeout": connection timeout to use in milliseconds"content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport"data": see RestClient::RestClient::DataSerializationOptions for possible values; the default is "json" "error_passthru": if True then HTTP status codes indicating errors will not cause a REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response"http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")"max_redirects": maximum redirects to support"proxy": proxy URL to use"redirect_passthru": if True then redirect responses will be passed to the caller instead of processed"send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies"timeout": transfer timeout to use in milliseconds
|
static |
DEPRECATED: static constructor.