1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/compute/v1/compute.proto 18 19 package com.google.cloud.compute.v1; 20 21 public interface OutlierDetectionOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.OutlierDetection) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. 31 * </pre> 32 * 33 * <code>optional .google.cloud.compute.v1.Duration base_ejection_time = 80997255;</code> 34 * 35 * @return Whether the baseEjectionTime field is set. 36 */ hasBaseEjectionTime()37 boolean hasBaseEjectionTime(); 38 /** 39 * 40 * 41 * <pre> 42 * The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. 43 * </pre> 44 * 45 * <code>optional .google.cloud.compute.v1.Duration base_ejection_time = 80997255;</code> 46 * 47 * @return The baseEjectionTime. 48 */ getBaseEjectionTime()49 com.google.cloud.compute.v1.Duration getBaseEjectionTime(); 50 /** 51 * 52 * 53 * <pre> 54 * The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. 55 * </pre> 56 * 57 * <code>optional .google.cloud.compute.v1.Duration base_ejection_time = 80997255;</code> 58 */ getBaseEjectionTimeOrBuilder()59 com.google.cloud.compute.v1.DurationOrBuilder getBaseEjectionTimeOrBuilder(); 60 61 /** 62 * 63 * 64 * <pre> 65 * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 66 * </pre> 67 * 68 * <code>optional int32 consecutive_errors = 387193248;</code> 69 * 70 * @return Whether the consecutiveErrors field is set. 71 */ hasConsecutiveErrors()72 boolean hasConsecutiveErrors(); 73 /** 74 * 75 * 76 * <pre> 77 * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 78 * </pre> 79 * 80 * <code>optional int32 consecutive_errors = 387193248;</code> 81 * 82 * @return The consecutiveErrors. 83 */ getConsecutiveErrors()84 int getConsecutiveErrors(); 85 86 /** 87 * 88 * 89 * <pre> 90 * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 91 * </pre> 92 * 93 * <code>optional int32 consecutive_gateway_failure = 417504250;</code> 94 * 95 * @return Whether the consecutiveGatewayFailure field is set. 96 */ hasConsecutiveGatewayFailure()97 boolean hasConsecutiveGatewayFailure(); 98 /** 99 * 100 * 101 * <pre> 102 * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 103 * </pre> 104 * 105 * <code>optional int32 consecutive_gateway_failure = 417504250;</code> 106 * 107 * @return The consecutiveGatewayFailure. 108 */ getConsecutiveGatewayFailure()109 int getConsecutiveGatewayFailure(); 110 111 /** 112 * 113 * 114 * <pre> 115 * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 116 * </pre> 117 * 118 * <code>optional int32 enforcing_consecutive_errors = 213133760;</code> 119 * 120 * @return Whether the enforcingConsecutiveErrors field is set. 121 */ hasEnforcingConsecutiveErrors()122 boolean hasEnforcingConsecutiveErrors(); 123 /** 124 * 125 * 126 * <pre> 127 * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 128 * </pre> 129 * 130 * <code>optional int32 enforcing_consecutive_errors = 213133760;</code> 131 * 132 * @return The enforcingConsecutiveErrors. 133 */ getEnforcingConsecutiveErrors()134 int getEnforcingConsecutiveErrors(); 135 136 /** 137 * 138 * 139 * <pre> 140 * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 141 * </pre> 142 * 143 * <code>optional int32 enforcing_consecutive_gateway_failure = 394440666;</code> 144 * 145 * @return Whether the enforcingConsecutiveGatewayFailure field is set. 146 */ hasEnforcingConsecutiveGatewayFailure()147 boolean hasEnforcingConsecutiveGatewayFailure(); 148 /** 149 * 150 * 151 * <pre> 152 * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. 153 * </pre> 154 * 155 * <code>optional int32 enforcing_consecutive_gateway_failure = 394440666;</code> 156 * 157 * @return The enforcingConsecutiveGatewayFailure. 158 */ getEnforcingConsecutiveGatewayFailure()159 int getEnforcingConsecutiveGatewayFailure(); 160 161 /** 162 * 163 * 164 * <pre> 165 * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. 166 * </pre> 167 * 168 * <code>optional int32 enforcing_success_rate = 194508732;</code> 169 * 170 * @return Whether the enforcingSuccessRate field is set. 171 */ hasEnforcingSuccessRate()172 boolean hasEnforcingSuccessRate(); 173 /** 174 * 175 * 176 * <pre> 177 * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. 178 * </pre> 179 * 180 * <code>optional int32 enforcing_success_rate = 194508732;</code> 181 * 182 * @return The enforcingSuccessRate. 183 */ getEnforcingSuccessRate()184 int getEnforcingSuccessRate(); 185 186 /** 187 * 188 * 189 * <pre> 190 * Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. 191 * </pre> 192 * 193 * <code>optional .google.cloud.compute.v1.Duration interval = 33547461;</code> 194 * 195 * @return Whether the interval field is set. 196 */ hasInterval()197 boolean hasInterval(); 198 /** 199 * 200 * 201 * <pre> 202 * Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. 203 * </pre> 204 * 205 * <code>optional .google.cloud.compute.v1.Duration interval = 33547461;</code> 206 * 207 * @return The interval. 208 */ getInterval()209 com.google.cloud.compute.v1.Duration getInterval(); 210 /** 211 * 212 * 213 * <pre> 214 * Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. 215 * </pre> 216 * 217 * <code>optional .google.cloud.compute.v1.Duration interval = 33547461;</code> 218 */ getIntervalOrBuilder()219 com.google.cloud.compute.v1.DurationOrBuilder getIntervalOrBuilder(); 220 221 /** 222 * 223 * 224 * <pre> 225 * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. 226 * </pre> 227 * 228 * <code>optional int32 max_ejection_percent = 18436888;</code> 229 * 230 * @return Whether the maxEjectionPercent field is set. 231 */ hasMaxEjectionPercent()232 boolean hasMaxEjectionPercent(); 233 /** 234 * 235 * 236 * <pre> 237 * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. 238 * </pre> 239 * 240 * <code>optional int32 max_ejection_percent = 18436888;</code> 241 * 242 * @return The maxEjectionPercent. 243 */ getMaxEjectionPercent()244 int getMaxEjectionPercent(); 245 246 /** 247 * 248 * 249 * <pre> 250 * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. 251 * </pre> 252 * 253 * <code>optional int32 success_rate_minimum_hosts = 525766903;</code> 254 * 255 * @return Whether the successRateMinimumHosts field is set. 256 */ hasSuccessRateMinimumHosts()257 boolean hasSuccessRateMinimumHosts(); 258 /** 259 * 260 * 261 * <pre> 262 * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. 263 * </pre> 264 * 265 * <code>optional int32 success_rate_minimum_hosts = 525766903;</code> 266 * 267 * @return The successRateMinimumHosts. 268 */ getSuccessRateMinimumHosts()269 int getSuccessRateMinimumHosts(); 270 271 /** 272 * 273 * 274 * <pre> 275 * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. 276 * </pre> 277 * 278 * <code>optional int32 success_rate_request_volume = 281425357;</code> 279 * 280 * @return Whether the successRateRequestVolume field is set. 281 */ hasSuccessRateRequestVolume()282 boolean hasSuccessRateRequestVolume(); 283 /** 284 * 285 * 286 * <pre> 287 * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. 288 * </pre> 289 * 290 * <code>optional int32 success_rate_request_volume = 281425357;</code> 291 * 292 * @return The successRateRequestVolume. 293 */ getSuccessRateRequestVolume()294 int getSuccessRateRequestVolume(); 295 296 /** 297 * 298 * 299 * <pre> 300 * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. 301 * </pre> 302 * 303 * <code>optional int32 success_rate_stdev_factor = 174735773;</code> 304 * 305 * @return Whether the successRateStdevFactor field is set. 306 */ hasSuccessRateStdevFactor()307 boolean hasSuccessRateStdevFactor(); 308 /** 309 * 310 * 311 * <pre> 312 * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. 313 * </pre> 314 * 315 * <code>optional int32 success_rate_stdev_factor = 174735773;</code> 316 * 317 * @return The successRateStdevFactor. 318 */ getSuccessRateStdevFactor()319 int getSuccessRateStdevFactor(); 320 } 321