com.linkedin.restli.client

Class ParSeqRestliClientBuilder

java.lang.Object

com.linkedin.restli.client.ParSeqRestliClientBuilder

public class ParSeqRestliClientBuilder
extends Object

A builder to construct ParSeqRestClient based on provided configurations.

Author:

Jaroslaw Odzga (jodzga@linkedin.com), Min Chen (mnchen@linkedin.com)

Constructor Summary

Constructors

Constructor and Description
ParSeqRestliClientBuilder()

Method Summary

Modifier and Type	Method and Description
ParSeqRestClient	build() This method may throw RuntimeException e.g.
com.linkedin.restli.client.Client	getRestClient() Deprecated. Calling #get in a builder is an anti-pattern
ParSeqRestliClientBuilder	setBatchingSupport(com.linkedin.parseq.batching.BatchingSupport batchingSupport)
ParSeqRestliClientBuilder	setClient(com.linkedin.restli.client.Client client)
ParSeqRestliClientBuilder	setConfig(ParSeqRestliClientConfig config)
ParSeqRestliClientBuilder	setD2RequestTimeoutEnabled(boolean enabled) Enables or disables d2 per-request timeout.
ParSeqRestliClientBuilder	setInboundRequestContextFinder(InboundRequestContextFinder inboundRequestContextFinder)
ParSeqRestliClientBuilder	setMultipleConfigs(Map<String,ParSeqRestliClientConfig> configs, ParSeqRestliClientConfigChooser chooser)
ParSeqRestliClientBuilder	setRequestContextProvider(Function<com.linkedin.restli.client.Request<?>,com.linkedin.r2.message.RequestContext> requestContextProvider)
ParSeqRestliClientBuilder	setRestClient(com.linkedin.restli.client.RestClient client) Deprecated. Use #setClient instead

Methods inherited from class java.lang.Object

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

Constructor Detail

ParSeqRestliClientBuilder

public ParSeqRestliClientBuilder()

Method Detail

build

public ParSeqRestClient build()

This method may throw RuntimeException e.g. when there is a problem with configuration.

Returns:

instance of ParSeqRestClient

Throws:

RuntimeException - e.g. when there is a problem with configuration

getRestClient

@Deprecated
public com.linkedin.restli.client.Client getRestClient()

Deprecated. Calling #get in a builder is an anti-pattern

Gets the underlying Rest.li client implementation.

Returns:

The underlying Rest.li client

setBatchingSupport

public ParSeqRestliClientBuilder setBatchingSupport(com.linkedin.parseq.batching.BatchingSupport batchingSupport)

setRestClient

@Deprecated
public ParSeqRestliClientBuilder setRestClient(com.linkedin.restli.client.RestClient client)

Deprecated. Use #setClient instead

Sets the underlying Rest.li client implementation.

Parameters:

client - The underlying Rest.li client

Returns:

The builder itself

setClient

public ParSeqRestliClientBuilder setClient(com.linkedin.restli.client.Client client)

setRequestContextProvider

public ParSeqRestliClientBuilder setRequestContextProvider(Function<com.linkedin.restli.client.Request<?>,com.linkedin.r2.message.RequestContext> requestContextProvider)

setConfig

public ParSeqRestliClientBuilder setConfig(ParSeqRestliClientConfig config)

setMultipleConfigs

public ParSeqRestliClientBuilder setMultipleConfigs(Map<String,ParSeqRestliClientConfig> configs,
                                                    ParSeqRestliClientConfigChooser chooser)

setInboundRequestContextFinder

public ParSeqRestliClientBuilder setInboundRequestContextFinder(InboundRequestContextFinder inboundRequestContextFinder)

setD2RequestTimeoutEnabled

public ParSeqRestliClientBuilder setD2RequestTimeoutEnabled(boolean enabled)

Enables or disables d2 per-request timeout. Once enabled, the timeout used in Parseq can be passed down into rest.li R2D2 layer and free up memory sooner than currently possible. For example, if the server defined requestTimeout is 10s, but the client only wants to wait 250ms, parseq rest client could tell r2d2 to trigger the user callback after 250 ms instead of 10s, which would help us handle the case of slow downstream services, which today cause memory problems for high qps upstream services because more objects are being held longer in memory.

Parameters:

enabled - true if this feature is enabled.