Class Backend.Builder (1.70.0) 

public static final class Backend.Builder extends GeneratedMessageV3.Builder<Backend.Builder> implements BackendOrBuilder

Message containing information of one individual backend.

Protobuf type google.cloud.compute.v1.Backend

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Backend.Builder

Implements

BackendOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCustomMetrics(Iterable<? extends BackendCustomMetric> values)

public Backend.Builder addAllCustomMetrics(Iterable<? extends BackendCustomMetric> values)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.BackendCustomMetric>
Returns
Type Description
Backend.Builder

addCustomMetrics(BackendCustomMetric value)

public Backend.Builder addCustomMetrics(BackendCustomMetric value)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
value BackendCustomMetric
Returns
Type Description
Backend.Builder

addCustomMetrics(BackendCustomMetric.Builder builderForValue)

public Backend.Builder addCustomMetrics(BackendCustomMetric.Builder builderForValue)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
builderForValue BackendCustomMetric.Builder
Returns
Type Description
Backend.Builder

addCustomMetrics(int index, BackendCustomMetric value)

public Backend.Builder addCustomMetrics(int index, BackendCustomMetric value)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameters
Name Description
index int
value BackendCustomMetric
Returns
Type Description
Backend.Builder

addCustomMetrics(int index, BackendCustomMetric.Builder builderForValue)

public Backend.Builder addCustomMetrics(int index, BackendCustomMetric.Builder builderForValue)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameters
Name Description
index int
builderForValue BackendCustomMetric.Builder
Returns
Type Description
Backend.Builder

addCustomMetricsBuilder()

public BackendCustomMetric.Builder addCustomMetricsBuilder()

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Returns
Type Description
BackendCustomMetric.Builder

addCustomMetricsBuilder(int index)

public BackendCustomMetric.Builder addCustomMetricsBuilder(int index)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
index int
Returns
Type Description
BackendCustomMetric.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Backend.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backend.Builder
Overrides

build()

public Backend build()
Returns
Type Description
Backend

buildPartial()

public Backend buildPartial()
Returns
Type Description
Backend

clear()

public Backend.Builder clear()
Returns
Type Description
Backend.Builder
Overrides

clearBalancingMode()

public Backend.Builder clearBalancingMode()

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
Type Description
Backend.Builder

This builder for chaining.

clearCapacityScaler()

public Backend.Builder clearCapacityScaler()

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
Type Description
Backend.Builder

This builder for chaining.

clearCustomMetrics()

public Backend.Builder clearCustomMetrics()

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Returns
Type Description
Backend.Builder

clearDescription()

public Backend.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
Backend.Builder

This builder for chaining.

clearFailover()

public Backend.Builder clearFailover()

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
Type Description
Backend.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Backend.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Backend.Builder
Overrides

clearGroup()

public Backend.Builder clearGroup()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxConnections()

public Backend.Builder clearMaxConnections()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxConnectionsPerEndpoint()

public Backend.Builder clearMaxConnectionsPerEndpoint()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxConnectionsPerInstance()

public Backend.Builder clearMaxConnectionsPerInstance()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxRate()

public Backend.Builder clearMaxRate()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxRatePerEndpoint()

public Backend.Builder clearMaxRatePerEndpoint()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxRatePerInstance()

public Backend.Builder clearMaxRatePerInstance()

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
Type Description
Backend.Builder

This builder for chaining.

clearMaxUtilization()

public Backend.Builder clearMaxUtilization()

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
Type Description
Backend.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Backend.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Backend.Builder
Overrides

clearPreference()

public Backend.Builder clearPreference()

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
Type Description
Backend.Builder

This builder for chaining.

clone()

public Backend.Builder clone()
Returns
Type Description
Backend.Builder
Overrides

getBalancingMode()

public 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
Type Description
String

The balancingMode.

getBalancingModeBytes()

public 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
Type Description
ByteString

The bytes for balancingMode.

getCapacityScaler()

public 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
Type Description
float

The capacityScaler.

getCustomMetrics(int index)

public BackendCustomMetric getCustomMetrics(int index)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
index int
Returns
Type Description
BackendCustomMetric

getCustomMetricsBuilder(int index)

public BackendCustomMetric.Builder getCustomMetricsBuilder(int index)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
index int
Returns
Type Description
BackendCustomMetric.Builder

getCustomMetricsBuilderList()

public List<BackendCustomMetric.Builder> getCustomMetricsBuilderList()

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Returns
Type Description
List<Builder>

getCustomMetricsCount()

public int getCustomMetricsCount()

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Returns
Type Description
int

getCustomMetricsList()

public List<BackendCustomMetric> getCustomMetricsList()

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Returns
Type Description
List<BackendCustomMetric>

getCustomMetricsOrBuilder(int index)

public BackendCustomMetricOrBuilder getCustomMetricsOrBuilder(int index)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
index int
Returns
Type Description
BackendCustomMetricOrBuilder

getCustomMetricsOrBuilderList()

public List<? extends BackendCustomMetricOrBuilder> getCustomMetricsOrBuilderList()

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.BackendCustomMetricOrBuilder>

getDefaultInstanceForType()

public Backend getDefaultInstanceForType()
Returns
Type Description
Backend

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFailover()

public 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
Type Description
boolean

The failover.

getGroup()

public 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
Type Description
String

The group.

getGroupBytes()

public 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
Type Description
ByteString

The bytes for group.

getMaxConnections()

public 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
Type Description
int

The maxConnections.

getMaxConnectionsPerEndpoint()

public 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
Type Description
int

The maxConnectionsPerEndpoint.

getMaxConnectionsPerInstance()

public 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
Type Description
int

The maxConnectionsPerInstance.

getMaxRate()

public 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
Type Description
int

The maxRate.

getMaxRatePerEndpoint()

public 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
Type Description
float

The maxRatePerEndpoint.

getMaxRatePerInstance()

public 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
Type Description
float

The maxRatePerInstance.

getMaxUtilization()

public 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
Type Description
float

The maxUtilization.

getPreference()

public 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
Type Description
String

The preference.

getPreferenceBytes()

public 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
Type Description
ByteString

The bytes for preference.

hasBalancingMode()

public 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
Type Description
boolean

Whether the balancingMode field is set.

hasCapacityScaler()

public 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
Type Description
boolean

Whether the capacityScaler field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasFailover()

public 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
Type Description
boolean

Whether the failover field is set.

hasGroup()

public 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
Type Description
boolean

Whether the group field is set.

hasMaxConnections()

public 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
Type Description
boolean

Whether the maxConnections field is set.

hasMaxConnectionsPerEndpoint()

public 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
Type Description
boolean

Whether the maxConnectionsPerEndpoint field is set.

hasMaxConnectionsPerInstance()

public 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
Type Description
boolean

Whether the maxConnectionsPerInstance field is set.

hasMaxRate()

public 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
Type Description
boolean

Whether the maxRate field is set.

hasMaxRatePerEndpoint()

public 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
Type Description
boolean

Whether the maxRatePerEndpoint field is set.

hasMaxRatePerInstance()

public 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
Type Description
boolean

Whether the maxRatePerInstance field is set.

hasMaxUtilization()

public 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
Type Description
boolean

Whether the maxUtilization field is set.

hasPreference()

public 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
Type Description
boolean

Whether the preference field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Backend other)

public Backend.Builder mergeFrom(Backend other)
Parameter
Name Description
other Backend
Returns
Type Description
Backend.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Backend.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backend.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Backend.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Backend.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Backend.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backend.Builder
Overrides

removeCustomMetrics(int index)

public Backend.Builder removeCustomMetrics(int index)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameter
Name Description
index int
Returns
Type Description
Backend.Builder

setBalancingMode(String value)

public Backend.Builder setBalancingMode(String value)

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;

Parameter
Name Description
value String

The balancingMode to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setBalancingModeBytes(ByteString value)

public Backend.Builder setBalancingModeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for balancingMode to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setCapacityScaler(float value)

public Backend.Builder setCapacityScaler(float value)

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;

Parameter
Name Description
value float

The capacityScaler to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setCustomMetrics(int index, BackendCustomMetric value)

public Backend.Builder setCustomMetrics(int index, BackendCustomMetric value)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameters
Name Description
index int
value BackendCustomMetric
Returns
Type Description
Backend.Builder

setCustomMetrics(int index, BackendCustomMetric.Builder builderForValue)

public Backend.Builder setCustomMetrics(int index, BackendCustomMetric.Builder builderForValue)

List of custom metrics that are used for CUSTOM_METRICS BalancingMode.

repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

Parameters
Name Description
index int
builderForValue BackendCustomMetric.Builder
Returns
Type Description
Backend.Builder

setDescription(String value)

public Backend.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Backend.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setFailover(boolean value)

public Backend.Builder setFailover(boolean value)

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;

Parameter
Name Description
value boolean

The failover to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Backend.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backend.Builder
Overrides

setGroup(String value)

public Backend.Builder setGroup(String value)

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;

Parameter
Name Description
value String

The group to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setGroupBytes(ByteString value)

public Backend.Builder setGroupBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for group to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxConnections(int value)

public Backend.Builder setMaxConnections(int value)

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;

Parameter
Name Description
value int

The maxConnections to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxConnectionsPerEndpoint(int value)

public Backend.Builder setMaxConnectionsPerEndpoint(int value)

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;

Parameter
Name Description
value int

The maxConnectionsPerEndpoint to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxConnectionsPerInstance(int value)

public Backend.Builder setMaxConnectionsPerInstance(int value)

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;

Parameter
Name Description
value int

The maxConnectionsPerInstance to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxRate(int value)

public Backend.Builder setMaxRate(int value)

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;

Parameter
Name Description
value int

The maxRate to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxRatePerEndpoint(float value)

public Backend.Builder setMaxRatePerEndpoint(float value)

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;

Parameter
Name Description
value float

The maxRatePerEndpoint to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxRatePerInstance(float value)

public Backend.Builder setMaxRatePerInstance(float value)

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;

Parameter
Name Description
value float

The maxRatePerInstance to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setMaxUtilization(float value)

public Backend.Builder setMaxUtilization(float value)

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;

Parameter
Name Description
value float

The maxUtilization to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setPreference(String value)

public Backend.Builder setPreference(String value)

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;

Parameter
Name Description
value String

The preference to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setPreferenceBytes(ByteString value)

public Backend.Builder setPreferenceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for preference to set.
Returns
Type Description
Backend.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Backend.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Backend.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Backend.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backend.Builder
Overrides