Interface BackendOrBuilder (1.47.0) 

public interface BackendOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBalancingMode()

public abstract String getBalancingMode()

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. Check the BalancingMode enum for the list of possible values.

optional string balancing_mode = 430286217;

Returns
TypeDescription
String

The balancingMode.

getBalancingModeBytes()

public abstract ByteString getBalancingModeBytes()

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. Check the BalancingMode enum for the list of possible values.

optional string balancing_mode = 430286217;

Returns
TypeDescription
ByteString

The bytes for balancingMode.

getCapacityScaler()

public abstract float getCapacityScaler()

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.

optional float capacity_scaler = 315958157;

Returns
TypeDescription
float

The capacityScaler.

getDescription()

public abstract String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getFailover()

public abstract boolean getFailover()

This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

optional bool failover = 138892530;

Returns
TypeDescription
boolean

The failover.

getGroup()

public abstract String getGroup()

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. 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.

optional string group = 98629247;

Returns
TypeDescription
String

The group.

getGroupBytes()

public abstract ByteString getGroupBytes()

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. 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.

optional string group = 98629247;

Returns
TypeDescription
ByteString

The bytes for group.

getMaxConnections()

public abstract int getMaxConnections()

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.

optional int32 max_connections = 110652154;

Returns
TypeDescription
int

The maxConnections.

getMaxConnectionsPerEndpoint()

public abstract int getMaxConnectionsPerEndpoint()

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.

optional int32 max_connections_per_endpoint = 216904604;

Returns
TypeDescription
int

The maxConnectionsPerEndpoint.

getMaxConnectionsPerInstance()

public abstract int getMaxConnectionsPerInstance()

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.

optional int32 max_connections_per_instance = 104671900;

Returns
TypeDescription
int

The maxConnectionsPerInstance.

getMaxRate()

public abstract int getMaxRate()

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.

optional int32 max_rate = 408035035;

Returns
TypeDescription
int

The maxRate.

getMaxRatePerEndpoint()

public abstract float getMaxRatePerEndpoint()

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.

optional float max_rate_per_endpoint = 129832283;

Returns
TypeDescription
float

The maxRatePerEndpoint.

getMaxRatePerInstance()

public abstract float getMaxRatePerInstance()

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.

optional float max_rate_per_instance = 17599579;

Returns
TypeDescription
float

The maxRatePerInstance.

getMaxUtilization()

public abstract float getMaxUtilization()

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.

optional float max_utilization = 148192199;

Returns
TypeDescription
float

The maxUtilization.

getPreference()

public abstract String getPreference()

This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default Check the Preference enum for the list of possible values.

optional string preference = 150781147;

Returns
TypeDescription
String

The preference.

getPreferenceBytes()

public abstract ByteString getPreferenceBytes()

This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default Check the Preference enum for the list of possible values.

optional string preference = 150781147;

Returns
TypeDescription
ByteString

The bytes for preference.

hasBalancingMode()

public abstract boolean hasBalancingMode()

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. Check the BalancingMode enum for the list of possible values.

optional string balancing_mode = 430286217;

Returns
TypeDescription
boolean

Whether the balancingMode field is set.

hasCapacityScaler()

public abstract boolean hasCapacityScaler()

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.

optional float capacity_scaler = 315958157;

Returns
TypeDescription
boolean

Whether the capacityScaler field is set.

hasDescription()

public abstract boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasFailover()

public abstract boolean hasFailover()

This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

optional bool failover = 138892530;

Returns
TypeDescription
boolean

Whether the failover field is set.

hasGroup()

public abstract boolean hasGroup()

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. 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.

optional string group = 98629247;

Returns
TypeDescription
boolean

Whether the group field is set.

hasMaxConnections()

public abstract boolean hasMaxConnections()

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.

optional int32 max_connections = 110652154;

Returns
TypeDescription
boolean

Whether the maxConnections field is set.

hasMaxConnectionsPerEndpoint()

public abstract boolean hasMaxConnectionsPerEndpoint()

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.

optional int32 max_connections_per_endpoint = 216904604;

Returns
TypeDescription
boolean

Whether the maxConnectionsPerEndpoint field is set.

hasMaxConnectionsPerInstance()

public abstract boolean hasMaxConnectionsPerInstance()

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.

optional int32 max_connections_per_instance = 104671900;

Returns
TypeDescription
boolean

Whether the maxConnectionsPerInstance field is set.

hasMaxRate()

public abstract boolean hasMaxRate()

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.

optional int32 max_rate = 408035035;

Returns
TypeDescription
boolean

Whether the maxRate field is set.

hasMaxRatePerEndpoint()

public abstract boolean hasMaxRatePerEndpoint()

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.

optional float max_rate_per_endpoint = 129832283;

Returns
TypeDescription
boolean

Whether the maxRatePerEndpoint field is set.

hasMaxRatePerInstance()

public abstract boolean hasMaxRatePerInstance()

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.

optional float max_rate_per_instance = 17599579;

Returns
TypeDescription
boolean

Whether the maxRatePerInstance field is set.

hasMaxUtilization()

public abstract boolean hasMaxUtilization()

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.

optional float max_utilization = 148192199;

Returns
TypeDescription
boolean

Whether the maxUtilization field is set.

hasPreference()

public abstract boolean hasPreference()

This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default Check the Preference enum for the list of possible values.

optional string preference = 150781147;

Returns
TypeDescription
boolean

Whether the preference field is set.