discord4j.rest.http.client

Class ClientRequest

java.lang.Object

discord4j.rest.http.client.ClientRequest

public class ClientRequest
extends Object

An adapted request definition from an original DiscordWebRequest.

Constructor Summary

Constructors

Constructor and Description
ClientRequest(DiscordWebRequest request) Create a new ClientRequest from the given request template.

Method Summary

Modifier and Type	Method and Description
Object	getBody() Return the body to encode while processing this request.
String	getDescription()
DiscordWebRequest	getDiscordRequest() Return the original request template.
HttpHeaders	getHeaders() Return the headers of this request.
String	getId() Return this request's ID for correlation.
HttpMethod	getMethod() Return the HTTP method.
Route	getRoute() Return the API endpoint targeted by this request.
String	getUrl() Return the request URL.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientRequest

public ClientRequest(DiscordWebRequest request)

Create a new ClientRequest from the given request template.

Parameters:

request - the DiscordWebRequest template

Method Detail

getId

public String getId()

Return this request's ID for correlation.

Returns:

this request's ID

getMethod

public HttpMethod getMethod()

Return the HTTP method.

Returns:

the HttpMethod of this ClientRequest

getUrl

public String getUrl()

Return the request URL.

Returns:

the request URL for this ClientRequest

getHeaders

public HttpHeaders getHeaders()

Return the headers of this request.

Returns:

the HttpHeaders of this ClientRequest

getBody

@Nullable
public Object getBody()

Return the body to encode while processing this request.

Returns:

the request body, can be null

getDiscordRequest

public DiscordWebRequest getDiscordRequest()

Return the original request template.

Returns:

the DiscordWebRequest template that created this ClientRequest

getRoute

public Route getRoute()

Return the API endpoint targeted by this request.

Returns:

the Route requested by this ClientRequest

getDescription

public String getDescription()

toString

public String toString()

Overrides:

toString in class Object