send_custom_request Method

Sends a custom request to the server.

Syntax

def send_custom_request(http_method: str, key_name: str, version_id: str, action: 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
• PATCH
• DELETE

KeyName and VersionId are optional. The former must be specified if the latter is specified; both are ignored if key_ring is empty. Action is also optional.

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, like https://cloudkms.googleapis.com/v1/projects/{GoogleProjectId}/locations/{Location}[/keyRings/{KeyRing}[/cryptoKeys/{KeyName}[/cryptoKeyVersions/{VersionId}]]][{Action}] using:
   • The google_project_id, location, and (if non-empty) key_ring properties.
   • The KeyName, VersionId, and Action parameters.
   • All query parameters from QueryParam*.
2. Adds an Authorization header with the value specified by authorization.
3. Adds any request headers from other_headers.
4. Adds any request body supplied via the specified input_file or input_data.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified output_file or output_data.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.