A flow control event. Record throttled time if LimitExceededBehavior is LimitExceededBehavior#Block, or the exception if the behavior is LimitExceededBehavior#ThrowException.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis webpage lists various versions of the \u003ccode\u003eFlowControlEventStats.FlowControlEvent\u003c/code\u003e class, with the latest version being 2.63.1, and contains a list of links to the documentation of older version all the way back to version 2.7.1.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFlowControlEventStats.FlowControlEvent\u003c/code\u003e is a class that implements the \u003ccode\u003eComparable\u003c/code\u003e interface, used to record data about flow control events.\u003c/p\u003e\n"],["\u003cp\u003eThe class \u003ccode\u003eFlowControlEventStats.FlowControlEvent\u003c/code\u003e has inherited members from \u003ccode\u003ejava.lang.Object\u003c/code\u003e such as \u003ccode\u003eclone()\u003c/code\u003e, \u003ccode\u003eequals()\u003c/code\u003e, \u003ccode\u003ehashCode()\u003c/code\u003e and more.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFlowControlEventStats.FlowControlEvent\u003c/code\u003e class includes methods to retrieve an exception (\u003ccode\u003egetException()\u003c/code\u003e), the throttled time (\u003ccode\u003egetThrottledTime()\u003c/code\u003e), the timestamp (\u003ccode\u003egetTimestampMs()\u003c/code\u003e), and implements a comparison method (\u003ccode\u003ecompareTo()\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFlowControlEventStats.FlowControlEvent\u003c/code\u003e class records the throttled time if LimitExceededBehavior is \u003ccode\u003eLimitExceededBehavior#Block\u003c/code\u003e, or the exception if the behavior is \u003ccode\u003eLimitExceededBehavior#ThrowException\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class FlowControlEventStats.FlowControlEvent (2.69.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.69.0 (latest)](/java/docs/reference/gax/latest/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent) \n\n public static class FlowControlEventStats.FlowControlEvent implements Comparable\u003cFlowControlEventStats.FlowControlEvent\u003e\n\nA flow control event. Record throttled time if LimitExceededBehavior is LimitExceededBehavior#Block, or the exception if the behavior is LimitExceededBehavior#ThrowException. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e FlowControlEventStats.FlowControlEvent \n\nImplements\n----------\n\n[Comparable\\\u003cFlowControlEventStats.FlowControlEvent\\\u003e](https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable\u003ccom/google/api/gax/batching/FlowControlEventStats/FlowControlEvent\u003e.html) \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nMethods\n-------\n\n### compareTo(FlowControlEventStats.FlowControlEvent otherEvent)\n\n public int compareTo(FlowControlEventStats.FlowControlEvent otherEvent)\n\n### getException()\n\n public FlowController.FlowControlException getException()\n\n### getThrottledTime(TimeUnit timeUnit)\n\n public Long getThrottledTime(TimeUnit timeUnit)\n\n### getTimestampMs()\n\n public long getTimestampMs()"]]
