This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
/
DynamicFlowControlSettings.java
175 lines (150 loc) · 7.27 KB
/
DynamicFlowControlSettings.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
* Copyright 2021 Google LLC
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.google.api.gax.batching;
import com.google.api.core.InternalApi;
import com.google.api.gax.batching.FlowController.LimitExceededBehavior;
import com.google.auto.value.AutoValue;
import com.google.common.base.Preconditions;
import javax.annotation.Nullable;
/** Settings for dynamic flow control */
@AutoValue
@InternalApi("For google-cloud-java client use only")
public abstract class DynamicFlowControlSettings {
/** Number of outstanding elements that {@link FlowController} allows when it's initiated. */
@Nullable
public abstract Long getInitialOutstandingElementCount();
/** Number of outstanding bytes that {@link FlowController} allows when it's initiated. */
@Nullable
public abstract Long getInitialOutstandingRequestBytes();
/**
* Maximum number of outstanding elements {@link FlowController} allows before enforcing flow
* control.
*/
@Nullable
public abstract Long getMaxOutstandingElementCount();
/**
* Maximum number of outstanding bytes {@link FlowController} allows before enforcing flow
* control.
*/
@Nullable
public abstract Long getMaxOutstandingRequestBytes();
/**
* Minimum number of outstanding elements {@link FlowController} allows before enforcing flow
* control.
*/
@Nullable
public abstract Long getMinOutstandingElementCount();
/**
* Minimum number of outstanding bytes {@link FlowController} allows before enforcing flow
* control.
*/
@Nullable
public abstract Long getMinOutstandingRequestBytes();
/** @see FlowControlSettings#getLimitExceededBehavior() */
public abstract LimitExceededBehavior getLimitExceededBehavior();
public abstract Builder toBuilder();
public static Builder newBuilder() {
return new AutoValue_DynamicFlowControlSettings.Builder()
.setLimitExceededBehavior(LimitExceededBehavior.Block);
}
@AutoValue.Builder
public abstract static class Builder {
public abstract Builder setInitialOutstandingElementCount(Long value);
public abstract Builder setInitialOutstandingRequestBytes(Long value);
public abstract Builder setMaxOutstandingElementCount(Long value);
public abstract Builder setMaxOutstandingRequestBytes(Long value);
public abstract Builder setMinOutstandingElementCount(Long value);
public abstract Builder setMinOutstandingRequestBytes(Long value);
public abstract Builder setLimitExceededBehavior(LimitExceededBehavior value);
abstract DynamicFlowControlSettings autoBuild();
public DynamicFlowControlSettings build() {
DynamicFlowControlSettings settings = autoBuild();
verifyElementCountSettings(settings);
verifyRequestBytesSettings(settings);
return settings;
}
private void verifyElementCountSettings(DynamicFlowControlSettings settings) {
// If LimitExceededBehavior is Ignore, dynamic flow control is disabled, there's no need to
// check element count limit settings
if (settings.getLimitExceededBehavior() == LimitExceededBehavior.Ignore) {
return;
}
if (settings.getInitialOutstandingElementCount() == null
&& settings.getMinOutstandingElementCount() == null
&& settings.getMaxOutstandingElementCount() == null) {
return;
}
Preconditions.checkState(
settings.getInitialOutstandingElementCount() != null
&& settings.getMinOutstandingElementCount() != null
&& settings.getMaxOutstandingElementCount() != null,
"Throttling on element count is disabled by default. To enable this setting,"
+ " minOutstandingElementCount, initialOutstandingElementCount, and "
+ "maxOutstandingElementCount must all be set.");
Preconditions.checkState(
settings.getMinOutstandingElementCount() > 0
&& settings.getInitialOutstandingElementCount()
<= settings.getMaxOutstandingElementCount()
&& settings.getInitialOutstandingElementCount()
>= settings.getMinOutstandingElementCount(),
"If throttling on element count is set, minOutstandingElementCount must be"
+ " greater than 0, and minOutstandingElementCount <= "
+ "initialOutstandingElementCount <= maxOutstandingElementCount");
}
private void verifyRequestBytesSettings(DynamicFlowControlSettings settings) {
// If LimitExceededBehavior is Ignore, dynamic flow control is disabled, there's no need to
// check request bytes limit settings
if (settings.getLimitExceededBehavior() == LimitExceededBehavior.Ignore) {
return;
}
if (settings.getInitialOutstandingRequestBytes() == null
&& settings.getMinOutstandingRequestBytes() == null
&& settings.getMaxOutstandingRequestBytes() == null) {
return;
}
Preconditions.checkState(
settings.getInitialOutstandingRequestBytes() != null
&& settings.getMinOutstandingRequestBytes() != null
&& settings.getMaxOutstandingRequestBytes() != null,
"Throttling on number of bytes is disabled by default. To enable this "
+ "setting, minOutstandingRequestBytes, initialOutstandingRequestBytes, and "
+ "maxOutstandingRequestBytes must all be set");
Preconditions.checkState(
settings.getMinOutstandingRequestBytes() > 0
&& settings.getInitialOutstandingRequestBytes()
<= settings.getMaxOutstandingRequestBytes()
&& settings.getInitialOutstandingRequestBytes()
>= settings.getMinOutstandingRequestBytes(),
"If throttling on number of bytes is set, minOutstandingRequestBytes must "
+ "be greater than 0, and minOutstandingRequestBytes <= "
+ "initialOutstandingRequestBytes <= maxOutstandingRequestBytes");
}
}
}