Package akka.http.javadsl.model
Class HttpRequest
- java.lang.Object
-
- akka.http.javadsl.model.HttpRequest
-
- All Implemented Interfaces:
HttpMessage
,HttpMessage.MessageTransformations<HttpRequest>
- Direct Known Subclasses:
HttpRequest
public abstract class HttpRequest extends java.lang.Object implements HttpMessage, HttpMessage.MessageTransformations<HttpRequest>
Represents an Http request.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface akka.http.javadsl.model.HttpMessage
HttpMessage.DiscardedEntity, HttpMessage.MessageTransformations<Self>
-
-
Constructor Summary
Constructors Constructor Description HttpRequest()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static HttpRequest
create()
Returns a default request to be modified using the `withX` methods.static HttpRequest
create(java.lang.String uri)
Returns a default request to the specified URI to be modified using the `withX` methods.static HttpRequest
DELETE(java.lang.String uri)
A default DELETE request to be modified using the `withX` methods.abstract RequestEntity
entity()
Returns the entity of this request.static HttpRequest
GET(java.lang.String uri)
A default GET request to be modified using the `withX` methods.abstract Uri
getUri()
Returns the Uri of this request.static HttpRequest
HEAD(java.lang.String uri)
A default HEAD request to be modified using the `withX` methods.abstract HttpMethod
method()
Returns the Http method of this request.static HttpRequest
OPTIONS(java.lang.String uri)
A default OPTIONS request to be modified using the `withX` methods.static HttpRequest
PATCH(java.lang.String uri)
A default PATCH request to be modified using the `withX` methods.static HttpRequest
POST(java.lang.String uri)
A default POST request to be modified using the `withX` methods.static HttpRequest
PUT(java.lang.String uri)
A default PUT request to be modified using the `withX` methods.abstract HttpRequest
withEntity(RequestEntity entity)
Returns a copy of this instance with a new entity.abstract HttpRequest
withMethod(HttpMethod method)
Returns a copy of this instance with a new method.abstract HttpRequest
withUri(Uri relativeUri)
Returns a copy of this instance with a new Uri.abstract HttpRequest
withUri(java.lang.String path)
Returns a copy of this instance with a new Uri.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface akka.http.javadsl.model.HttpMessage
discardEntityBytes, discardEntityBytes, getAttribute, getHeader, getHeader, getHeaders, getHeaders, isRequest, isResponse, protocol
-
Methods inherited from interface akka.http.javadsl.model.HttpMessage.MessageTransformations
addAttribute, addCredentials, addHeader, addHeaders, removeAttribute, removeHeader, toStrict, toStrict, toStrict, toStrict, transformEntityDataBytes, withEntity, withEntity, withEntity, withEntity, withEntity, withEntity, withEntity, withEntity, withHeaders, withProtocol
-
-
-
-
Method Detail
-
method
public abstract HttpMethod method()
Returns the Http method of this request.
-
getUri
public abstract Uri getUri()
Returns the Uri of this request.
-
entity
public abstract RequestEntity entity()
Returns the entity of this request.- Specified by:
entity
in interfaceHttpMessage
-
withMethod
public abstract HttpRequest withMethod(HttpMethod method)
Returns a copy of this instance with a new method.
-
withUri
public abstract HttpRequest withUri(Uri relativeUri)
Returns a copy of this instance with a new Uri.
-
withUri
public abstract HttpRequest withUri(java.lang.String path)
Returns a copy of this instance with a new Uri.
-
withEntity
public abstract HttpRequest withEntity(RequestEntity entity)
Returns a copy of this instance with a new entity.- Specified by:
withEntity
in interfaceHttpMessage.MessageTransformations<HttpRequest>
-
create
public static HttpRequest create()
Returns a default request to be modified using the `withX` methods.
-
create
public static HttpRequest create(java.lang.String uri)
Returns a default request to the specified URI to be modified using the `withX` methods.
-
GET
public static HttpRequest GET(java.lang.String uri)
A default GET request to be modified using the `withX` methods.
-
POST
public static HttpRequest POST(java.lang.String uri)
A default POST request to be modified using the `withX` methods.
-
PUT
public static HttpRequest PUT(java.lang.String uri)
A default PUT request to be modified using the `withX` methods.
-
DELETE
public static HttpRequest DELETE(java.lang.String uri)
A default DELETE request to be modified using the `withX` methods.
-
HEAD
public static HttpRequest HEAD(java.lang.String uri)
A default HEAD request to be modified using the `withX` methods.
-
PATCH
public static HttpRequest PATCH(java.lang.String uri)
A default PATCH request to be modified using the `withX` methods.
-
OPTIONS
public static HttpRequest OPTIONS(java.lang.String uri)
A default OPTIONS request to be modified using the `withX` methods.
-
-