com.google.api.gax.batching

Class FlowController

java.lang.Object

com.google.api.gax.batching.FlowController

@BetaApi(value="The surface for batching is not stable yet and may change in the future.")
public class FlowController
extends Object

Provides flow control capability.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowController.FlowControlException Base exception that signals a flow control state.
static class	FlowController.FlowControlRuntimeException Runtime exception that can be used in place of FlowControlException when an unchecked exception is required.
static class	FlowController.LimitExceededBehavior Enumeration of behaviors that FlowController can use in case the flow control limits are exceeded.
static class	FlowController.MaxOutstandingElementCountReachedException Exception thrown when client-side flow control is enforced based on the maximum number of outstanding in-memory elements.
static class	FlowController.MaxOutstandingRequestBytesReachedException Exception thrown when client-side flow control is enforced based on the maximum number of unacknowledged in-memory bytes.

Constructor Summary

Constructors

Constructor and Description
FlowController(DynamicFlowControlSettings settings)
FlowController(FlowControlSettings settings)

Method Summary

Modifier and Type	Method and Description
void	decreaseThresholds(long elementSteps, long byteSteps) Decrease flow control limits to allow elementSteps fewer elements and byteSteps fewer request bytes before enforcing flow control.
Long	getCurrentElementCountLimit()
Long	getCurrentRequestBytesLimit()
FlowControlEventStats	getFlowControlEventStats()
Long	getMaxElementCountLimit()
Long	getMaxRequestBytesLimit()
Long	getMinElementCountLimit()
Long	getMinRequestBytesLimit()
void	increaseThresholds(long elementSteps, long byteSteps) Increase flow control limits to allow extra elementSteps elements and byteSteps request bytes before enforcing flow control.
void	release(long elements, long bytes)
void	reserve(long elements, long bytes)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowController

public FlowController(FlowControlSettings settings)

FlowController

@InternalApi(value="For google-cloud-java client use only")
public FlowController(DynamicFlowControlSettings settings)

Method Detail

reserve

public void reserve(long elements,
                    long bytes)
             throws FlowController.FlowControlException

Throws:

FlowController.FlowControlException

release

public void release(long elements,
                    long bytes)

increaseThresholds

@InternalApi(value="For google-cloud-java client use only")
public void increaseThresholds(long elementSteps,
                                                                                           long byteSteps)

Increase flow control limits to allow extra elementSteps elements and byteSteps request bytes before enforcing flow control.

decreaseThresholds

@InternalApi(value="For google-cloud-java client use only")
public void decreaseThresholds(long elementSteps,
                                                                                           long byteSteps)

Decrease flow control limits to allow elementSteps fewer elements and byteSteps fewer request bytes before enforcing flow control.

getMaxElementCountLimit

@InternalApi(value="For internal use by google-cloud-java clients only")
 @Nullable
public Long getMaxElementCountLimit()

getMaxRequestBytesLimit

@InternalApi(value="For internal use by google-cloud-java clients only")
 @Nullable
public Long getMaxRequestBytesLimit()

getMinElementCountLimit

@InternalApi(value="For google-cloud-java client use only")
 @Nullable
public Long getMinElementCountLimit()

getMinRequestBytesLimit

@InternalApi(value="For google-cloud-java client use only")
 @Nullable
public Long getMinRequestBytesLimit()

getCurrentElementCountLimit

@InternalApi(value="For google-cloud-java client use only")
 @Nullable
public Long getCurrentElementCountLimit()

getCurrentRequestBytesLimit

@InternalApi(value="For google-cloud-java client use only")
 @Nullable
public Long getCurrentRequestBytesLimit()

getFlowControlEventStats

@InternalApi(value="For google-cloud-java client use only")
public FlowControlEventStats getFlowControlEventStats()