Package com.mongodb.stitch.core.internal.net

Class StitchRequest.Builder

java.lang.Object

com.mongodb.stitch.core.internal.net.StitchRequest.Builder

Direct Known Subclasses:

StitchAuthRequest.Builder, StitchDocRequest.Builder

Enclosing class:

StitchRequest

public static class StitchRequest.Builder
extends Object

A builder that can build StitchRequests.

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new builder.

Method Summary

Modifier and Type	Method	Description
StitchRequest	build()	Builds, validates, and returns the StitchRequest.
byte[]	getBody()	Returns a copy of the body that will be sent along with the request.
Map<String,String>	getHeaders()	Returns the headers that will be included in the request.
Method	getMethod()	Returns the HTTP method of the request.
String	getPath()	Returns the Stitch API path of the request.
Long	getTimeout()	Returns the number of milliseconds that the underlying transport should spend on an HTTP round trip before failing with an error.
StitchRequest.Builder	withBody(byte[] body)	Sets a copy of the body that will be sent along with the request.
StitchRequest.Builder	withHeaders(Map<String,String> headers)	Sets the headers that will be included in the request.
StitchRequest.Builder	withMethod(Method method)	Sets the HTTP method of the request.
StitchRequest.Builder	withPath(String path)	Sets the Stitch API path of the request.
StitchRequest.Builder	withTimeout(Long timeout)	Sets the number of milliseconds that the underlying transport should spend on an HTTP round trip before failing with an error.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a new builder.

Method Detail

withMethod

public StitchRequest.Builder withMethod(Method method)

Sets the HTTP method of the request.

Parameters:

method - the HTTP method of the request.

Returns:

the builder.

withPath

public StitchRequest.Builder withPath(String path)

Sets the Stitch API path of the request.

Parameters:

path - the Stitch API path of the request.

Returns:

the builder.

withTimeout

public StitchRequest.Builder withTimeout(Long timeout)

Sets the number of milliseconds that the underlying transport should spend on an HTTP round trip before failing with an error. If not configured, a default should override it before the request is transformed into a plain HTTP request.

Parameters:

timeout - the number of milliseconds that the underlying transport should spend on an HTTP round trip before failing with an error.

Returns:

the builder.

withHeaders

public StitchRequest.Builder withHeaders(Map<String,String> headers)

Sets the headers that will be included in the request.

Parameters:

headers - the headers that will be included in the request.

Returns:

the builder.

withBody

public StitchRequest.Builder withBody(byte[] body)

Sets a copy of the body that will be sent along with the request.

Parameters:

body - a copy of the body that will be sent along with the request.

Returns:

the builder.

getMethod

public Method getMethod()

Returns the HTTP method of the request.

Returns:

the HTTP method of the request.

getPath

public String getPath()

Returns the Stitch API path of the request.

Returns:

the Stitch API path of the request.

getTimeout

public Long getTimeout()

Returns the number of milliseconds that the underlying transport should spend on an HTTP round trip before failing with an error. If not configured, a default should override it before the request is transformed into a plain HTTP request.

Returns:

the number of milliseconds that the underlying transport should spend on an HTTP round trip before failing with an error.

getHeaders

public Map<String,String> getHeaders()

Returns the headers that will be included in the request.

Returns:

the headers that will be included in the request.

getBody

public byte[] getBody()

Returns a copy of the body that will be sent along with the request.

Returns:

a copy of the body that will be sent along with the request.

build

public StitchRequest build()

Builds, validates, and returns the StitchRequest.

Returns:

the built the StitchRequest.