okhttp3

Class Request.Builder

java.lang.Object

okhttp3.Request.Builder

Enclosing class:

Request

public static class Request.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Request.Builder	addHeader(String name, String value) Adds a header with name and value.
Request	build()
Request.Builder	cacheControl(CacheControl cacheControl) Sets this request's Cache-Control header, replacing any cache control headers already present.
Request.Builder	delete()
Request.Builder	delete(RequestBody body)
Request.Builder	get()
Request.Builder	head()
Request.Builder	header(String name, String value) Sets the header named name to value.
Request.Builder	headers(Headers headers) Removes all headers on this builder and adds headers.
Request.Builder	method(String method, RequestBody body)
Request.Builder	patch(RequestBody body)
Request.Builder	post(RequestBody body)
Request.Builder	put(RequestBody body)
Request.Builder	removeHeader(String name) Removes all headers named name on this builder.
<T> Request.Builder	tag(Class<? super T> type, T tag) Attaches tag to the request using type as a key.
Request.Builder	tag(Object tag) Attaches tag to the request using Object.class as a key.
Request.Builder	url(HttpUrl url)
Request.Builder	url(String url) Sets the URL target of this request.
Request.Builder	url(URL url) Sets the URL target of this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

url

public Request.Builder url(HttpUrl url)

url

public Request.Builder url(String url)

Sets the URL target of this request.

Throws:

IllegalArgumentException - if url is not a valid HTTP or HTTPS URL. Avoid this exception by calling HttpUrl.parse(java.lang.String); it returns null for invalid URLs.

url

public Request.Builder url(URL url)

Sets the URL target of this request.

Throws:

IllegalArgumentException - if the scheme of url is not http or https.

header

public Request.Builder header(String name,
                              String value)

Sets the header named name to value. If this request already has any headers with that name, they are all replaced.

addHeader

public Request.Builder addHeader(String name,
                                 String value)

Adds a header with name and value. Prefer this method for multiply-valued headers like "Cookie".

Note that for some headers including Content-Length and Content-Encoding, OkHttp may replace value with a header derived from the request body.

removeHeader

public Request.Builder removeHeader(String name)

Removes all headers named name on this builder.

headers

public Request.Builder headers(Headers headers)

Removes all headers on this builder and adds headers.

cacheControl

public Request.Builder cacheControl(CacheControl cacheControl)

Sets this request's Cache-Control header, replacing any cache control headers already present. If cacheControl doesn't define any directives, this clears this request's cache-control headers.

get

public Request.Builder get()

head

public Request.Builder head()

post

public Request.Builder post(RequestBody body)

delete

public Request.Builder delete(@Nullable
                              RequestBody body)

delete

public Request.Builder delete()

put

public Request.Builder put(RequestBody body)

patch

public Request.Builder patch(RequestBody body)

method

public Request.Builder method(String method,
                              @Nullable
                              RequestBody body)

tag

public Request.Builder tag(@Nullable
                           Object tag)

Attaches tag to the request using Object.class as a key.

tag

public <T> Request.Builder tag(Class<? super T> type,
                               @Nullable
                               T tag)

Attaches tag to the request using type as a key. Tags can be read from a request using Request.tag(). Use null to remove any existing tag assigned for type.

Use this API to attach timing, debugging, or other application data to a request so that you may read it in interceptors, event listeners, or callbacks.

build

public Request build()