Cloud Keys 2020 Python Edition

Questions / Feedback?

send_custom_request Method

Sends a custom request to the server.

Syntax

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

SecretName, VersionId, Action, and Body are optional. If SecretName is empty, VersionId will be ignored.

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

  1. Builds a request URL, including query parameters, like https://secretmanager.googleapis.com/v1/projects/{GoogleProjectId}[/secrets/{SecretName}[/versions/{VersionId}]][{Action}] using:
    • The google_project_id property.
    • The SecretName, 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 the specified request Body, if non-empty.
  5. Sends the request to the server.
  6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file or secret_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.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Python Edition - Version 20.0 [Build 8157]