send_custom_request Method
Sends a custom request to the server.
Syntax
def send_custom_request(http_method: str, object_name: str, request_body: str) -> None: ...
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The ObjectName and RequestBody parameters may be empty if not needed.
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, based on the following:
- use_ssl, region, and use_virtual_hosting for the base URL.
- Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
- bucket (if non-empty)
- ObjectName (if non-empty)
- version_id (if both it and ObjectName are non-empty)
- QueryParam*
- use_ssl, region, and use_virtual_hosting for the base URL.
- Adds request headers from:
- Signs the request (unless the SignCustomRequest configuration setting is disabled).
- Sends the request, including RequestBody if non-empty.
- Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file, or object_data (using the same logic as get_object).
If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.