SendCustomRequest Method
Sends a custom request to the server.
Syntax
ANSI (Cross Platform) int SendCustomRequest(const char* lpszHttpMethod, const char* lpszSecretName, const char* lpszVersionId, const char* lpszAction, const char* lpszBody); Unicode (Windows) INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszSecretName, LPCWSTR lpszVersionId, LPCWSTR lpszAction, LPCWSTR lpszBody);
- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)secretName :(NSString*)versionId :(NSString*)action :(NSString*)body;
#define MID_GOOGLESECRETS_SENDCUSTOMREQUEST 16 CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_GoogleSecrets_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
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:
- Builds a request URL, including query parameters, like https://secretmanager.googleapis.com/v1/projects/{GoogleProjectId}[/secrets/{SecretName}[/versions/{VersionId}]][{Action}] using:
- The GoogleProjectId property.
- The SecretName, VersionId, and Action parameters.
- All query parameters from QueryParam*.
- Adds an Authorization header with the value specified by Authorization.
- Adds any request headers from OtherHeaders.
- Adds the specified request Body, if non-empty.
- Sends the request to the server.
- Stores the response headers in the ParsedHeader* properties; and the response body in the stream specified using SetOutputStream, the specified LocalFile, or SecretData.
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)