public class HTTPRequest implements SerializableHTTPRequest encapsulates a single HTTP request that is made
via the URLFetchService.
Implements
SerializableConstructors
HTTPRequest(URL url)
public HTTPRequest(URL url)Creates a HTTPRequest that represents a GET request to
the specified URL.
| Parameter | |
|---|---|
| Name | Description |
url |
URL |
HTTPRequest(URL url, HTTPMethod method)
public HTTPRequest(URL url, HTTPMethod method)Creates a HTTPRequest that represents an HTTP request to
the specified URL with the specified HTTP method (GET, POST, etc).
| Parameters | |
|---|---|
| Name | Description |
url |
URL |
method |
HTTPMethod |
HTTPRequest(URL url, HTTPMethod method, FetchOptions fetchOptions)
public HTTPRequest(URL url, HTTPMethod method, FetchOptions fetchOptions)Creates a HTTPRequest that represents an HTTP request to
the specified URL with the specified HTTP method (GET, POST, etc)
and the specified FetchOptions.
| Parameters | |
|---|---|
| Name | Description |
url |
URL |
method |
HTTPMethod |
fetchOptions |
FetchOptions |
Methods
addHeader(HTTPHeader header)
public void addHeader(HTTPHeader header)Adds header to this request. If an HTTPHeader with the same name
already exists for this request, it's values are merged with header.
| Parameter | |
|---|---|
| Name | Description |
header |
HTTPHeadera not |
getFetchOptions()
public FetchOptions getFetchOptions()Get the fetch options for this request.
| Returns | |
|---|---|
| Type | Description |
FetchOptions |
|
getHeaders()
public List<HTTPHeader> getHeaders()Returns an immutable List of HTTPHeader objects
that have been added to this request.
| Returns | |
|---|---|
| Type | Description |
List<HTTPHeader> |
|
getMethod()
public HTTPMethod getMethod()Gets the HTTP method for this request (GET, POST, etc).
| Returns | |
|---|---|
| Type | Description |
HTTPMethod |
|
getPayload()
public byte @Nullable [] getPayload()Gets the payload (such as POST body) for this request. Certain HTTP methods (e.g. GET) will not have any payload, and this method will return null.
| Returns | |
|---|---|
| Type | Description |
byte @org.jspecify.annotations.Nullable [] |
|
getURL()
public URL getURL()Gets the URL for this request.
| Returns | |
|---|---|
| Type | Description |
URL |
|
setHeader(HTTPHeader header)
public void setHeader(HTTPHeader header)Sets an HTTPHeader for this request. If an
HTTPHeader with the same name
already exists, its value is replaced.
| Parameter | |
|---|---|
| Name | Description |
header |
HTTPHeader |
setPayload(byte[] payload)
public void setPayload(byte[] payload)Sets the payload for this request. This method should not be called for certain HTTP methods (e.g. GET).
| Parameter | |
|---|---|
| Name | Description |
payload |
byte[] |