SendCustomRequest Method

Sends a custom request to the server.

Syntax

public func sendCustomRequest(httpMethod: String, keyName: String, versionId: String, action: String) throws -> Void

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 KeyRing 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 GoogleProjectId, Location, and (if non-empty) KeyRing 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 OtherHeaders.
  4. Adds any request body supplied via the specified InputFile or InputData.
  5. Sends the request to the server.
  6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified OutputFile or OutputData.

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) 2021 /n software inc. - All rights reserved.
Cloud Keys 2020 macOS Edition - Version 20.0 [Build 7876]