org.apache.gobblin.restli.throttling

Class PermitsRequestBuilders

java.lang.Object

com.linkedin.restli.client.base.BuilderBase

org.apache.gobblin.restli.throttling.PermitsRequestBuilders

@Generated(value="com.linkedin.pegasus.generator.JavaCodeUtil",
           comments="Rest.li Request Builder. Generated from gobblin-restli/gobblin-throttling-service/gobblin-throttling-service-api/src/main/idl/org.apache.gobblin.restli.throttling.permits.restspec.json.")
public class PermitsRequestBuilders
extends com.linkedin.restli.client.base.BuilderBase

Restli resource for allocating permits through Rest calls. Simply calls a Limiter in the server configured through SharedResourcesBroker. generated from: org.apache.gobblin.restli.throttling.LimiterServerResource

Field Summary

Fields inherited from class com.linkedin.restli.client.base.BuilderBase

_requestOptions

Constructor Summary

Constructors

Constructor and Description
PermitsRequestBuilders()
PermitsRequestBuilders(com.linkedin.restli.client.RestliRequestOptions requestOptions)
PermitsRequestBuilders(java.lang.String primaryResourceName)
PermitsRequestBuilders(java.lang.String primaryResourceName, com.linkedin.restli.client.RestliRequestOptions requestOptions)

Method Summary

Modifier and Type	Method and Description
PermitsGetRequestBuilder	get() Request permits from the limiter server.
static java.lang.String	getPrimaryResource()
com.linkedin.restli.client.OptionsRequestBuilder	options()

Methods inherited from class com.linkedin.restli.client.base.BuilderBase

getBaseUriTemplate, getPathComponents, getRequestOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

PermitsRequestBuilders

public PermitsRequestBuilders()

PermitsRequestBuilders

public PermitsRequestBuilders(com.linkedin.restli.client.RestliRequestOptions requestOptions)

PermitsRequestBuilders

public PermitsRequestBuilders(java.lang.String primaryResourceName)

PermitsRequestBuilders

public PermitsRequestBuilders(java.lang.String primaryResourceName,
                              com.linkedin.restli.client.RestliRequestOptions requestOptions)

Method Detail

getPrimaryResource

public static java.lang.String getPrimaryResource()

options

public com.linkedin.restli.client.OptionsRequestBuilder options()

get

public PermitsGetRequestBuilder get()

Request permits from the limiter server. The returned PermitAllocation specifies the number of permits that the client can use.

Returns:

builder for the resource method