ClientRequestInfo

Client to function service HTTPS request information

Since R2024a

Description

The ClientRequestInfo object contains the information required to make an HTTPS request from the client application to the function service. For an example, see Call User-Defined Function with MATLAB REST Function Services.

Creation

To obtain a ClientRequestInfo object, call the start method of a RESTFunctionService object.

Properties

ClientAccessMode — Client mode allowed by service

local (default) | remote

This property is read-only.

Specifies whether service allows local or remote client requests, returned as local or remote.

RequestUrl — HTTPS request URL

string scalar

This property is read-only.

URL for making an HTTPS request to this service, returned as a string scalar.

Example: "https://localhost:9920/matlab/feval/v1/EA"

CertificateLocation — Certificate pathname

string scalar

This property is read-only.

Path to the local or remote certificate (.pem) file used in the client application for making an HTTPS request, returned as a string scalar.

Example: "C:\Users\<username>\AppData\Local\MathWorks \restfcnconnector\publickey.pem"

RESTPersonalAccessToken — HTTPS request token

string scalar

This property is read-only.

Token to be specified in the client request with the HTTP mwRESTPersonalAccessToken header field, returned as a string scalar.

Example: "AQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyA="

Version History

Introduced in R2024a