Object -
http
:
Request
Represents an HTTP request.
Methods
Entity
to the request.
Entity
associated with the request.
100-continue
response.
content-type
header to the request.
json
payload from the request.
xml
payload from the request.
text
payload from the request.
ByteChannel
except in the case of multiparts.
byte[]
.
map
when content type is application/x-www-form-urlencoded.
json
as the payload.
xml
as the payload.
string
as the payload.
byte[]
as the payload.
ByteChannel
as the payload.
Fields
- rawPath string
-
Resource path of the request URL
- method string
-
The HTTP request method
- httpVersion string
-
The HTTP version supported by the client
- userAgent string
-
The user-agent. This value is used when setting the
user-agent
header
- extraPathInfo string
-
The part of the URL, which matched to '*' if the request is dispatched to a wildcard resource
- cacheControl RequestCacheControl? (default ())
-
The cache-control directives for the request. This needs to be explicitly initialized if intending on utilizing HTTP caching.
- mutualSslHandshake MutualSslHandshake? (default ())
-
A record providing mutual ssl handshake results.
Entity
to the request.
Parameters
- e Entity
-
The
Entity
to be set to the request
-
Return Type
(map) String array map of the query params
Parameters
- key string
-
Represents the query param key
-
Return Type
(string?) The query param value associated with the given key as a string. If multiple param values are present, then the first value is returned.
()
is returned if no key is found.
Parameters
- key string
-
Represents the query param key
-
Return Type
(string[]?) All the query param values associated with the given key as a
string[]
.()
is returned if no key is found.
Parameters
- path string
-
Path to the location of matrix parameters
-
Return Type
(map) A map of matrix parameters which can be found for the given path
Entity
associated with the request.
-
Return Type
(Entity | ClientError) The
Entity
of the request. Anhttp:ClientError
is returned, if entity construction fails
Parameters
- headerName string
-
The header name
-
Return Type
(boolean) Returns true if the specified header key exists
Parameters
- headerName string
-
The header name
-
Return Type
(string) The first header value for the specified header name. Panic if the header is not found. Use the
Request.hasHeader()
beforehand to check the existence of a header.
Parameters
- headerName string
-
The header name
-
Return Type
(string[]) The header values the specified header key maps to. Panic if the header is not found. Use the
Request.hasHeader()
beforehand to check the existence of a header.
Parameters
- headerName string
-
The header name
- headerValue string
-
The header value
Parameters
- headerName string
-
The header name
- headerValue string
-
The header value
-
Return Type
(string[]) An array of all the header names
100-continue
response.
-
Return Type
(boolean) Returns true if the client expects a
100-continue
response
content-type
header to the request.
Parameters
- contentType string
-
Content type value to be set as the
content-type
header
-
Return Type
(error?) Nil if successful, error in case of invalid content-type
content-type
header value).
-
Return Type
(string) The
content-type
header value as a string
json
payload from the request. If the content type is not JSON, an http:ClientError
is returned.
-
Return Type
(json | ClientError) The
json
payload orhttp:ClientError
in case of errors
xml
payload from the request. If the content type is not XML, an http:ClientError
is returned.
-
Return Type
(xml | ClientError) The
xml
payload orhttp:ClientError
in case of errors
text
payload from the request. If the content type is not of type text, an http:ClientError
is returned.
-
Return Type
(string | ClientError) The
text
payload orhttp:ClientError
in case of errors
ByteChannel
except in the case of multiparts. To retrieve multiparts, use
Request.getBodyParts()
.
-
Return Type
(ReadableByteChannel | ClientError) A byte channel from which the message payload can be read or
http:ClientError
in case of errors
byte[]
.
-
Return Type
(byte[] | ClientError) The byte[] representation of the message payload or
http:ClientError
in case of errors
map
when content type is application/x-www-form-urlencoded.
-
Return Type
(map | ClientError) The map of form params or
http:ClientError
in case of errors
-
Return Type
(Entity[] | ClientError) The body parts as an array of entities or else an
http:ClientError
if there were any errors constructing the body parts from the request
json
as the payload.
Parameters
- payload json
-
The
json
payload
- contentType string (default application/json)
-
The content type of the payload. Set this to override the default
content-type
header value forjson
xml
as the payload.
Parameters
- payload xml
-
The
xml
payload
- contentType string (default application/xml)
-
The content type of the payload. Set this to override the default
content-type
header value forxml
string
as the payload.
Parameters
- payload string
-
The
string
payload
- contentType string (default text/plain)
-
The content type of the payload. Set this to override the default
content-type
header value forstring
byte[]
as the payload.
Parameters
- payload byte[]
-
The
byte[]
payload
- contentType string (default application/octet-stream)
-
The content type of the payload. Set this to override the default
content-type
header value forbyte[]
Parameters
- bodyParts Entity[]
-
The entities which make up the message body
- contentType string (default multipart/form-data)
-
The content type of the top level message. Set this to override the default
content-type
header value
Parameters
- filePath string
-
Path to the file to be set as the payload
- contentType string (default application/octet-stream)
-
The content type of the specified file. Set this to override the default
content-type
header value
ByteChannel
as the payload.
Parameters
- payload ReadableByteChannel
-
A
ByteChannel
through which the message payload can be read
- contentType string (default application/octet-stream)
-
The content type of the payload. Set this to override the default
content-type
header value
text/plain
. To send a JSON-compatible string,
set the content-type header to application/json
or use the setJsonPayload
method instead.
Parameters
- payload string | xml | json | byte[] | ReadableByteChannel | Entity[]
-
Payload can be of type
string
,xml
,json
,byte[]
,ByteChannel
, orEntity[]
(i.e., a set of body parts).
Parameters
- cookiesToAdd Cookie[]
-
Represents the cookies to be added