com.algolia.search.saas

Class RequestOptions

Object

com.algolia.search.saas.RequestOptions

public class RequestOptions
extends Object

Per-request options. This class allows specifying options at the request level, overriding default options at the Client level. NOTE: These are reserved for advanced use cases. In most situations, they shouldn't be needed.

Constructor Summary

Constructors

Constructor and Description
RequestOptions() Construct empty request options.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getHeader(String name) Get the value of a HTTP header.
String	getUrlParameter(String name) Get the value of a URL parameter.
RequestOptions	setHeader(String name, String value) Set a HTTP header (untyped version).
RequestOptions	setUrlParameter(String name, String value) Set a URL parameter (untyped version).
String	toString()

Methods inherited from class Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestOptions

public RequestOptions()

Construct empty request options.

Method Detail

setHeader

public RequestOptions setHeader(@NonNull
                                String name,
                                @Nullable
                                String value)

Set a HTTP header (untyped version). Whenever possible, you should use a typed accessor.

Parameters:

name - Name of the header.

value - Value of the header, or `null` to remove the header.

getHeader

public String getHeader(@NonNull
                        String name)

Get the value of a HTTP header.

Parameters:

name - Name of the header.

Returns:

Value of the header, or `null` if it does not exist.

setUrlParameter

public RequestOptions setUrlParameter(@NonNull
                                      String name,
                                      @Nullable
                                      String value)

Set a URL parameter (untyped version). Whenever possible, you should use a typed accessor.

Parameters:

name - Name of the parameter.

value - Value of the parameter, or `null` to remove it.

getUrlParameter

public String getUrlParameter(@NonNull
                              String name)

Get the value of a URL parameter.

Parameters:

name - Name of the parameter.

Returns:

Value of the parameter, or `null` if it does not exist.

toString

@NonNull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object