FlowControlSettings (GAX (Google Api eXtensions) for Java (Core) 2.23.2 API)

java.lang.Object
- com.google.api.gax.batching.FlowControlSettings

public abstract class FlowControlSettings
extends Object

Settings for FlowController.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FlowControlSettings.Builder

Constructor Summary

Constructors
Constructor Description

FlowControlSettings()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static FlowControlSettings`	`getDefaultInstance()`
`abstract FlowController.LimitExceededBehavior`	`getLimitExceededBehavior()`	The behavior of `FlowController` when the specified limits are exceeded.
`abstract Long`	`getMaxOutstandingElementCount()`	Maximum number of outstanding elements to keep in memory before enforcing flow control.
`abstract Long`	`getMaxOutstandingRequestBytes()`	Maximum number of outstanding bytes to keep in memory before enforcing flow control.
`static FlowControlSettings.Builder`	`newBuilder()`
`abstract FlowControlSettings.Builder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FlowControlSettings
```
public FlowControlSettings()
```
- Method Detail
  - getDefaultInstance
```
public static FlowControlSettings getDefaultInstance()
```
  - getMaxOutstandingElementCount
```
@Nullable
public abstract Long getMaxOutstandingElementCount()
```
    Maximum number of outstanding elements to keep in memory before enforcing flow control.
  - getMaxOutstandingRequestBytes
```
@Nullable
public abstract Long getMaxOutstandingRequestBytes()
```
    Maximum number of outstanding bytes to keep in memory before enforcing flow control.
  - getLimitExceededBehavior
```
public abstract FlowController.LimitExceededBehavior getLimitExceededBehavior()
```
    The behavior of FlowController when the specified limits are exceeded. Defaults to Block.
    The expected behavior for each of these values is:
    
    ThrowException: the FlowController will throw a FlowController.FlowControlException if any of the limits are exceeded.
    Block: the reserve() method of FlowController will block until the quote is available to be reserved.
    Ignore: all flow control limits will be ignored; the FlowController is disabled.
  - toBuilder
```
public abstract FlowControlSettings.Builder toBuilder()
```
  - newBuilder
```
public static FlowControlSettings.Builder newBuilder()
```