Class FlowController (2.83.0)

2.83.0 (latest) 2.82.0 2.81.0 2.80.0 2.79.0 2.76.0 2.75.0 2.74.1 2.73.1 2.72.2 2.71.0 2.70.3 2.69.0 2.68.2 2.67.0 2.66.0 2.65.0 2.63.1 2.62.0 2.61.0 2.60.0 2.59.1 2.58.0 2.57.0 2.55.0 2.54.1 2.53.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.1 2.47.0 2.46.1 2.45.0 2.43.0 2.42.0 2.41.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.1 2.33.0 2.32.1 2.31.1 2.30.1 2.24.0 2.23.3 2.22.0 2.21.0 2.20.1 2.19.6 2.18.7 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.2 2.11.0 2.10.0 2.9.0 2.8.1 2.7.1

public class FlowController

Provides flow control capability.

Inheritance

java.lang.Object > FlowController

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

FlowController(DynamicFlowControlSettings settings)

public FlowController(DynamicFlowControlSettings settings)

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

Parameter
Name	Description
settings	DynamicFlowControlSettings

FlowController(FlowControlSettings settings)

public FlowController(FlowControlSettings settings)

Parameter
Name	Description
settings	FlowControlSettings

Methods

decreaseThresholds(long elementSteps, long byteSteps)

public void decreaseThresholds(long elementSteps, long byteSteps)

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

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

Parameters
Name	Description
elementSteps	long
byteSteps	long

getCurrentElementCountLimit()

public @Nullable Long getCurrentElementCountLimit()

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.Long

getCurrentRequestBytesLimit()

public @Nullable Long getCurrentRequestBytesLimit()

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.Long

getFlowControlEventStats()

public FlowControlEventStats getFlowControlEventStats()

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

Returns
Type	Description
FlowControlEventStats

getMaxElementCountLimit()

public @Nullable Long getMaxElementCountLimit()

Internal Only: This feature is not stable for application use.

For internal use by google-cloud-java clients only

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.Long

getMaxRequestBytesLimit()

public @Nullable Long getMaxRequestBytesLimit()

Internal Only: This feature is not stable for application use.

For internal use by google-cloud-java clients only

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.Long

getMinElementCountLimit()

public @Nullable Long getMinElementCountLimit()

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.Long

getMinRequestBytesLimit()

public @Nullable Long getMinRequestBytesLimit()

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.Long

increaseThresholds(long elementSteps, long byteSteps)

public void increaseThresholds(long elementSteps, long byteSteps)

Internal Only: This feature is not stable for application use.

For google-cloud-java client use only

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

Parameters
Name	Description
elementSteps	long
byteSteps	long

release(long elements, long bytes)

public void release(long elements, long bytes)

Parameters
Name	Description
elements	long
bytes	long

reserve(long elements, long bytes)

public void reserve(long elements, long bytes)

Parameters
Name	Description
elements	long
bytes	long

Exceptions
Type	Description
FlowController.FlowControlException