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 BackendOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.Backend) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. 31 * Check the BalancingMode enum for the list of possible values. 32 * </pre> 33 * 34 * <code>optional string balancing_mode = 430286217;</code> 35 * 36 * @return Whether the balancingMode field is set. 37 */ hasBalancingMode()38 boolean hasBalancingMode(); 39 /** 40 * 41 * 42 * <pre> 43 * Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. 44 * Check the BalancingMode enum for the list of possible values. 45 * </pre> 46 * 47 * <code>optional string balancing_mode = 430286217;</code> 48 * 49 * @return The balancingMode. 50 */ getBalancingMode()51 java.lang.String getBalancingMode(); 52 /** 53 * 54 * 55 * <pre> 56 * Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. 57 * Check the BalancingMode enum for the list of possible values. 58 * </pre> 59 * 60 * <code>optional string balancing_mode = 430286217;</code> 61 * 62 * @return The bytes for balancingMode. 63 */ getBalancingModeBytes()64 com.google.protobuf.ByteString getBalancingModeBytes(); 65 66 /** 67 * 68 * 69 * <pre> 70 * A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. 71 * </pre> 72 * 73 * <code>optional float capacity_scaler = 315958157;</code> 74 * 75 * @return Whether the capacityScaler field is set. 76 */ hasCapacityScaler()77 boolean hasCapacityScaler(); 78 /** 79 * 80 * 81 * <pre> 82 * A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. 83 * </pre> 84 * 85 * <code>optional float capacity_scaler = 315958157;</code> 86 * 87 * @return The capacityScaler. 88 */ getCapacityScaler()89 float getCapacityScaler(); 90 91 /** 92 * 93 * 94 * <pre> 95 * An optional description of this resource. Provide this property when you create the resource. 96 * </pre> 97 * 98 * <code>optional string description = 422937596;</code> 99 * 100 * @return Whether the description field is set. 101 */ hasDescription()102 boolean hasDescription(); 103 /** 104 * 105 * 106 * <pre> 107 * An optional description of this resource. Provide this property when you create the resource. 108 * </pre> 109 * 110 * <code>optional string description = 422937596;</code> 111 * 112 * @return The description. 113 */ getDescription()114 java.lang.String getDescription(); 115 /** 116 * 117 * 118 * <pre> 119 * An optional description of this resource. Provide this property when you create the resource. 120 * </pre> 121 * 122 * <code>optional string description = 422937596;</code> 123 * 124 * @return The bytes for description. 125 */ getDescriptionBytes()126 com.google.protobuf.ByteString getDescriptionBytes(); 127 128 /** 129 * 130 * 131 * <pre> 132 * This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 133 * </pre> 134 * 135 * <code>optional bool failover = 138892530;</code> 136 * 137 * @return Whether the failover field is set. 138 */ hasFailover()139 boolean hasFailover(); 140 /** 141 * 142 * 143 * <pre> 144 * This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 145 * </pre> 146 * 147 * <code>optional bool failover = 138892530;</code> 148 * 149 * @return The failover. 150 */ getFailover()151 boolean getFailover(); 152 153 /** 154 * 155 * 156 * <pre> 157 * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. 158 * </pre> 159 * 160 * <code>optional string group = 98629247;</code> 161 * 162 * @return Whether the group field is set. 163 */ hasGroup()164 boolean hasGroup(); 165 /** 166 * 167 * 168 * <pre> 169 * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. 170 * </pre> 171 * 172 * <code>optional string group = 98629247;</code> 173 * 174 * @return The group. 175 */ getGroup()176 java.lang.String getGroup(); 177 /** 178 * 179 * 180 * <pre> 181 * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. 182 * </pre> 183 * 184 * <code>optional string group = 98629247;</code> 185 * 186 * @return The bytes for group. 187 */ getGroupBytes()188 com.google.protobuf.ByteString getGroupBytes(); 189 190 /** 191 * 192 * 193 * <pre> 194 * Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. 195 * </pre> 196 * 197 * <code>optional int32 max_connections = 110652154;</code> 198 * 199 * @return Whether the maxConnections field is set. 200 */ hasMaxConnections()201 boolean hasMaxConnections(); 202 /** 203 * 204 * 205 * <pre> 206 * Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. 207 * </pre> 208 * 209 * <code>optional int32 max_connections = 110652154;</code> 210 * 211 * @return The maxConnections. 212 */ getMaxConnections()213 int getMaxConnections(); 214 215 /** 216 * 217 * 218 * <pre> 219 * Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. 220 * </pre> 221 * 222 * <code>optional int32 max_connections_per_endpoint = 216904604;</code> 223 * 224 * @return Whether the maxConnectionsPerEndpoint field is set. 225 */ hasMaxConnectionsPerEndpoint()226 boolean hasMaxConnectionsPerEndpoint(); 227 /** 228 * 229 * 230 * <pre> 231 * Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. 232 * </pre> 233 * 234 * <code>optional int32 max_connections_per_endpoint = 216904604;</code> 235 * 236 * @return The maxConnectionsPerEndpoint. 237 */ getMaxConnectionsPerEndpoint()238 int getMaxConnectionsPerEndpoint(); 239 240 /** 241 * 242 * 243 * <pre> 244 * Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. 245 * </pre> 246 * 247 * <code>optional int32 max_connections_per_instance = 104671900;</code> 248 * 249 * @return Whether the maxConnectionsPerInstance field is set. 250 */ hasMaxConnectionsPerInstance()251 boolean hasMaxConnectionsPerInstance(); 252 /** 253 * 254 * 255 * <pre> 256 * Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. 257 * </pre> 258 * 259 * <code>optional int32 max_connections_per_instance = 104671900;</code> 260 * 261 * @return The maxConnectionsPerInstance. 262 */ getMaxConnectionsPerInstance()263 int getMaxConnectionsPerInstance(); 264 265 /** 266 * 267 * 268 * <pre> 269 * Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. 270 * </pre> 271 * 272 * <code>optional int32 max_rate = 408035035;</code> 273 * 274 * @return Whether the maxRate field is set. 275 */ hasMaxRate()276 boolean hasMaxRate(); 277 /** 278 * 279 * 280 * <pre> 281 * Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. 282 * </pre> 283 * 284 * <code>optional int32 max_rate = 408035035;</code> 285 * 286 * @return The maxRate. 287 */ getMaxRate()288 int getMaxRate(); 289 290 /** 291 * 292 * 293 * <pre> 294 * Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. 295 * </pre> 296 * 297 * <code>optional float max_rate_per_endpoint = 129832283;</code> 298 * 299 * @return Whether the maxRatePerEndpoint field is set. 300 */ hasMaxRatePerEndpoint()301 boolean hasMaxRatePerEndpoint(); 302 /** 303 * 304 * 305 * <pre> 306 * Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. 307 * </pre> 308 * 309 * <code>optional float max_rate_per_endpoint = 129832283;</code> 310 * 311 * @return The maxRatePerEndpoint. 312 */ getMaxRatePerEndpoint()313 float getMaxRatePerEndpoint(); 314 315 /** 316 * 317 * 318 * <pre> 319 * Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. 320 * </pre> 321 * 322 * <code>optional float max_rate_per_instance = 17599579;</code> 323 * 324 * @return Whether the maxRatePerInstance field is set. 325 */ hasMaxRatePerInstance()326 boolean hasMaxRatePerInstance(); 327 /** 328 * 329 * 330 * <pre> 331 * Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. 332 * </pre> 333 * 334 * <code>optional float max_rate_per_instance = 17599579;</code> 335 * 336 * @return The maxRatePerInstance. 337 */ getMaxRatePerInstance()338 float getMaxRatePerInstance(); 339 340 /** 341 * 342 * 343 * <pre> 344 * Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode. 345 * </pre> 346 * 347 * <code>optional float max_utilization = 148192199;</code> 348 * 349 * @return Whether the maxUtilization field is set. 350 */ hasMaxUtilization()351 boolean hasMaxUtilization(); 352 /** 353 * 354 * 355 * <pre> 356 * Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode. 357 * </pre> 358 * 359 * <code>optional float max_utilization = 148192199;</code> 360 * 361 * @return The maxUtilization. 362 */ getMaxUtilization()363 float getMaxUtilization(); 364 } 365