Compute Engine v1 API - Class Backend (2.17.0)

public sealed class Backend : IMessage<Backend>, IEquatable<Backend>, IDeepCloneable<Backend>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class Backend.

Message containing information of one individual backend.

Inheritance

object > Backend

Implements

IMessage Backend, IEquatable Backend, IDeepCloneable Backend, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Backend()

public Backend()

Backend(Backend)

public Backend(Backend other)

Parameter
Name	Description
`other`	`Backend`

Properties

BalancingMode

public string BalancingMode { get; set; }

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.

Property Value
Type	Description
`string`

CapacityScaler

public float CapacityScaler { get; set; }

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.

Property Value
Type	Description
`float`

Description

public string Description { get; set; }

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

Property Value
Type	Description
`string`

Failover

public bool Failover { get; set; }

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

Property Value
Type	Description
`bool`

Group

public string Group { get; set; }

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.

Property Value
Type	Description
`string`

HasBalancingMode

public bool HasBalancingMode { get; }

Gets whether the "balancing_mode" field is set

Property Value
Type	Description
`bool`

HasCapacityScaler

public bool HasCapacityScaler { get; }

Gets whether the "capacity_scaler" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasFailover

public bool HasFailover { get; }

Gets whether the "failover" field is set

Property Value
Type	Description
`bool`

HasGroup

public bool HasGroup { get; }

Gets whether the "group" field is set

Property Value
Type	Description
`bool`

HasMaxConnections

public bool HasMaxConnections { get; }

Gets whether the "max_connections" field is set

Property Value
Type	Description
`bool`

HasMaxConnectionsPerEndpoint

public bool HasMaxConnectionsPerEndpoint { get; }

Gets whether the "max_connections_per_endpoint" field is set

Property Value
Type	Description
`bool`

HasMaxConnectionsPerInstance

public bool HasMaxConnectionsPerInstance { get; }

Gets whether the "max_connections_per_instance" field is set

Property Value
Type	Description
`bool`

HasMaxRate

public bool HasMaxRate { get; }

Gets whether the "max_rate" field is set

Property Value
Type	Description
`bool`

HasMaxRatePerEndpoint

public bool HasMaxRatePerEndpoint { get; }

Gets whether the "max_rate_per_endpoint" field is set

Property Value
Type	Description
`bool`

HasMaxRatePerInstance

public bool HasMaxRatePerInstance { get; }

Gets whether the "max_rate_per_instance" field is set

Property Value
Type	Description
`bool`

HasMaxUtilization

public bool HasMaxUtilization { get; }

Gets whether the "max_utilization" field is set

Property Value
Type	Description
`bool`

HasPreference

public bool HasPreference { get; }

Gets whether the "preference" field is set

Property Value
Type	Description
`bool`

MaxConnections

public int MaxConnections { get; set; }

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.

Property Value
Type	Description
`int`

MaxConnectionsPerEndpoint

public int MaxConnectionsPerEndpoint { get; set; }

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.

Property Value
Type	Description
`int`

MaxConnectionsPerInstance

public int MaxConnectionsPerInstance { get; set; }

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.

Property Value
Type	Description
`int`

MaxRate

public int MaxRate { get; set; }

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.

Property Value
Type	Description
`int`

MaxRatePerEndpoint

public float MaxRatePerEndpoint { get; set; }

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.

Property Value
Type	Description
`float`

MaxRatePerInstance

public float MaxRatePerInstance { get; set; }

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.

Property Value
Type	Description
`float`

MaxUtilization

public float MaxUtilization { get; set; }

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.

Property Value
Type	Description
`float`

Preference

public string Preference { get; set; }

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.

Property Value
Type	Description
`string`