com.linkedin.restli.client

Class ParSeqRestClient

java.lang.Object

com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>

com.linkedin.restli.client.ParSeqRestClient

All Implemented Interfaces:

ParSeqRestliClient

public class ParSeqRestClient
extends com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>
implements ParSeqRestliClient

A ParSeq client that creates a ParSeq task from a rest.li Request by sending the request to underlying rest.li Client. ParSeqRestClient delegates task execution to Rest.li Client Client.sendRequest(Request, Callback) method that takes a PromiseCallbackAdapter. ParSeq task created from ParSeqRestClient may fail when PromiseCallbackAdapter receives the following error conditions:

1. @{link RestLiResponseExcepion}: Request has reached Rest.li server and rest.li server throws RestLiServiceException. 2. @{link RemoteInvocationException}: Request failed before reaching rest.li server, for example, RestException thrown from request filters, ServiceUnavailableException when client cannot find available server instance that could serve the request, etc. 3. @{link TimeoutException}: Request times out after configured timeoutMs.

Author:

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

Field Summary

Fields inherited from class com.linkedin.parseq.batching.BatchingStrategy

DEFAULT_MAX_BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
ParSeqRestClient(com.linkedin.restli.client.Client client) Deprecated. Please use ParSeqRestliClientBuilder to create instances.
ParSeqRestClient(com.linkedin.restli.client.RestClient client) Deprecated. Please use ParSeqRestliClientBuilder to create instances.

Method Summary

Modifier and Type	Method and Description
com.linkedin.restli.client.RequestGroup	classify(com.linkedin.restli.client.RestRequestBatchKey key)
<T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>>	createTask(com.linkedin.restli.client.Request<T> request) Creates a task that makes rest.li request and returns response.
<T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>>	createTask(com.linkedin.restli.client.Request<T> request, RequestConfigOverrides configOverrides) Creates a task that makes rest.li request and returns response.
<T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>>	createTask(com.linkedin.restli.client.Request<T> request, com.linkedin.r2.message.RequestContext requestContext) Creates a task that makes rest.li request and returns response.
<T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>>	createTask(com.linkedin.restli.client.Request<T> request, com.linkedin.r2.message.RequestContext requestContext, RequestConfigOverrides configOverrides) Creates a task that makes rest.li request and returns response.
<T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>>	createTask(String name, com.linkedin.restli.client.Request<T> request, com.linkedin.r2.message.RequestContext requestContext) Deprecated. ParSeqRestClient generates consistent names for tasks based on request parameters and it is recommended to us default names.
void	executeBatch(com.linkedin.restli.client.RequestGroup group, com.linkedin.parseq.batching.Batch<com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>> batch)
BatchingMetrics	getBatchingMetrics()
String	getBatchName(com.linkedin.restli.client.RequestGroup group, com.linkedin.parseq.batching.Batch<com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>> batch)
Metrics	getMetrics() Returns ParSeq rest.li client's metrics.
int	keySize(com.linkedin.restli.client.RequestGroup group, com.linkedin.restli.client.RestRequestBatchKey key)
int	maxBatchSizeForGroup(com.linkedin.restli.client.RequestGroup group)
<T> com.linkedin.parseq.promise.Promise<com.linkedin.restli.client.Response<T>>	sendRequest(com.linkedin.restli.client.Request<T> request) Deprecated.
<T> com.linkedin.parseq.promise.Promise<com.linkedin.restli.client.Response<T>>	sendRequest(com.linkedin.restli.client.Request<T> request, com.linkedin.r2.message.RequestContext requestContext) Deprecated.

Methods inherited from class com.linkedin.parseq.batching.BatchingStrategy

batchable, batchable, executeBatchWithContext, getBatchAggregationTimeMetric, getBatchSizeMetric

Methods inherited from class java.lang.Object

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

Constructor Detail

ParSeqRestClient

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

Deprecated. Please use ParSeqRestliClientBuilder to create instances.

Creates new ParSeqRestClient with default configuration.

ParSeqRestClient

@Deprecated
public ParSeqRestClient(com.linkedin.restli.client.RestClient client)

Deprecated. Please use ParSeqRestliClientBuilder to create instances.

Creates new ParSeqRestClient with default configuration.

Method Detail

sendRequest

@Deprecated
public <T> com.linkedin.parseq.promise.Promise<com.linkedin.restli.client.Response<T>> sendRequest(com.linkedin.restli.client.Request<T> request)

Deprecated.

Description copied from interface: ParSeqRestliClient

Sends a type-bound REST request, returning a promise.

Specified by:

sendRequest in interface ParSeqRestliClient

Type Parameters:

T - type of the result

Parameters:

request - to send

Returns:

response promise

See Also:

ParSeqRestliClient.createTask(Request)

sendRequest

@Deprecated
public <T> com.linkedin.parseq.promise.Promise<com.linkedin.restli.client.Response<T>> sendRequest(com.linkedin.restli.client.Request<T> request,
                                                                                                               com.linkedin.r2.message.RequestContext requestContext)

Deprecated.

Description copied from interface: ParSeqRestliClient

Sends a type-bound REST request, returning a promise.

Specified by:

sendRequest in interface ParSeqRestliClient

Type Parameters:

T - type of the result

Parameters:

request - to send

requestContext - context for the request

Returns:

response promise

createTask

public <T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>> createTask(com.linkedin.restli.client.Request<T> request)

Description copied from interface: ParSeqRestliClient

Creates a task that makes rest.li request and returns response.

Specified by:

createTask in interface ParSeqRestliClient

Type Parameters:

T - type of the result

Parameters:

request - request to be made

Returns:

Task that returns response for given request

createTask

public <T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>> createTask(com.linkedin.restli.client.Request<T> request,
                                                                                       com.linkedin.r2.message.RequestContext requestContext)

Description copied from interface: ParSeqRestliClient

Creates a task that makes rest.li request and returns response.

Specified by:

createTask in interface ParSeqRestliClient

Type Parameters:

T - type of the result

Parameters:

request - request to be made

requestContext - context for the request

Returns:

Task that returns response

createTask

@Deprecated
public <T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>> createTask(String name,
                                                                                                   com.linkedin.restli.client.Request<T> request,
                                                                                                   com.linkedin.r2.message.RequestContext requestContext)

Deprecated. ParSeqRestClient generates consistent names for tasks based on request parameters and it is recommended to us default names.

createTask

public <T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>> createTask(com.linkedin.restli.client.Request<T> request,
                                                                                       RequestConfigOverrides configOverrides)

Description copied from interface: ParSeqRestliClient

Creates a task that makes rest.li request and returns response.

Passed in configOverrides will override any existing configuration. Not all properties need to be set. Use RequestConfigOverridesBuilder to create instance of RequestConfigOverrides.

Specified by:

createTask in interface ParSeqRestliClient

Type Parameters:

T - type of the result

Parameters:

request - request to be made

configOverrides - configuration overrides

Returns:

Task that returns response

createTask

public <T> com.linkedin.parseq.Task<com.linkedin.restli.client.Response<T>> createTask(com.linkedin.restli.client.Request<T> request,
                                                                                       com.linkedin.r2.message.RequestContext requestContext,
                                                                                       RequestConfigOverrides configOverrides)

Description copied from interface: ParSeqRestliClient

Creates a task that makes rest.li request and returns response.

Passed in configOverrides will override any existing configuration. Not all properties need to be set. Use RequestConfigOverridesBuilder to create instance of RequestConfigOverrides.

Specified by:

createTask in interface ParSeqRestliClient

Type Parameters:

T - type of the result

Parameters:

request - request to be made

requestContext - context for the request

configOverrides - configuration overrides

Returns:

Task that returns response

executeBatch

public void executeBatch(com.linkedin.restli.client.RequestGroup group,
                         com.linkedin.parseq.batching.Batch<com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>> batch)

Specified by:

executeBatch in class com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>

classify

public com.linkedin.restli.client.RequestGroup classify(com.linkedin.restli.client.RestRequestBatchKey key)

Specified by:

classify in class com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>

getBatchName

public String getBatchName(com.linkedin.restli.client.RequestGroup group,
                           com.linkedin.parseq.batching.Batch<com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>> batch)

Overrides:

getBatchName in class com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>

keySize

public int keySize(com.linkedin.restli.client.RequestGroup group,
                   com.linkedin.restli.client.RestRequestBatchKey key)

Overrides:

keySize in class com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>

maxBatchSizeForGroup

public int maxBatchSizeForGroup(com.linkedin.restli.client.RequestGroup group)

Overrides:

maxBatchSizeForGroup in class com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.restli.client.RequestGroup,com.linkedin.restli.client.RestRequestBatchKey,com.linkedin.restli.client.Response<Object>>

getBatchingMetrics

public BatchingMetrics getBatchingMetrics()

getMetrics

public Metrics getMetrics()

Description copied from interface: ParSeqRestliClient

Returns ParSeq rest.li client's metrics.

Specified by:

getMetrics in interface ParSeqRestliClient

Returns:

metrics