OCI REST for ESP32
Public Member Functions | Public Attributes | List of all members
ociApiRequest Struct Reference

A request contains all of the information required to make a call to the OCI API. More...

#include <oci.h>

Public Member Functions

 ociApiRequest (char *host, char *path, const char *requestMethod, Header *requestHeaders={}, int requestHeaderCount=0, char *endpointCert=NULL, char *content="", char *contentType="application/json")
 An OCI API request. More...
 

Public Attributes

char * host
 The REST API endpoint host. Ex: objectstorage.us-phoenix-1.oraclecloud.com.
 
char * path
 The path. Ex: "/n/".
 
const char * requestMethod
 The HTTP method. See Oci for const values.
 
char * endpointCert =NULL
 The text value of the Root CA cert for the API endpoint. Used to make secure connections. For examp, run openssl s_client -connect objectstorage.us-phoenix-1.oraclecloud.com:443 -showcerts and find the value of the Root CA Cert.
 
char * content = ""
 The body to be passed to the API call.
 
char * contentType ="application/json"
 The content type.
 
HeaderrequestHeaders
 An array of Header objects (set both key and value)
 
int requestHeaderCount
 The count of headers in the requestHeaders array.
 

Detailed Description

A request contains all of the information required to make a call to the OCI API.

Constructor & Destructor Documentation

◆ ociApiRequest()

ociApiRequest::ociApiRequest ( char *  host,
char *  path,
const char *  requestMethod,
Header requestHeaders = {},
int  requestHeaderCount = 0,
char *  endpointCert = NULL,
char *  content = "",
char *  contentType = "application/json" 
)
inline

An OCI API request.

Parameters
hostThe REST API endpoint host. Ex: objectstorage.us-phoenix-1.oraclecloud.com
pathThe path. Ex: "/n/"
requestMethodThe HTTP method. See Oci for const values.
requestHeadersAn array of Header objects (set both key and value)
requestHeaderCountThe count of headers in the requestHeaders array
endpointCertThe text value of the Root CA cert for the API endpoint. Used to make secure connections. For examp, run openssl s_client -connect objectstorage.us-phoenix-1.oraclecloud.com:443 -showcerts and find the value of the Root CA Cert.
contentThe body to be passed to the API call.
contentTypeThe content type

The documentation for this struct was generated from the following file: